Update docu for ppHeapTree
authorJoachim Breitner <mail@joachim-breitner.de>
Thu, 20 Dec 2012 10:20:02 +0000 (10:20 +0000)
committerJoachim Breitner <mail@joachim-breitner.de>
Thu, 20 Dec 2012 10:20:02 +0000 (10:20 +0000)
src/GHC/HeapView.hs

index ca179f0..7b03017 100644 (file)
@@ -688,9 +688,10 @@ buildHeapTree n b = do
 
 -- | Pretty-Printing a heap Tree
 -- 
--- Example output for @[Just 4, Nothing]@:
+-- Example output for @[Just 4, Nothing, *something*]@, where *something* is an
+-- unevaluated expression depending on the command line argument.
 --
--- > : (Just (I# 4)) (: Nothing [])
+-- >[Just (I# 4),Nothing,Just (_thunk ["arg1","arg2"])]
 ppHeapTree :: HeapTree -> String
 ppHeapTree = go 0
   where