summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaavo <pparkkin@gmail.com>2020-03-11 21:49:36 +0200
committerMarge Bot <ben+marge-bot@smart-cactus.org>2020-03-13 02:31:03 -0400
commit2f292db8f10134919c420b71b8a5eccd379212ad (patch)
tree5d77c23cd602cad6b2091f38a3c3e3856ff95044
parent44fad4a925c06fa2b14611ea08acea9210ee4e00 (diff)
downloadhaskell-2f292db8f10134919c420b71b8a5eccd379212ad.tar.gz
Update documentation for closureSize
-rw-r--r--libraries/ghc-heap/GHC/Exts/Heap/Closures.hs3
1 files changed, 2 insertions, 1 deletions
diff --git a/libraries/ghc-heap/GHC/Exts/Heap/Closures.hs b/libraries/ghc-heap/GHC/Exts/Heap/Closures.hs
index b247266a10..bb9d440b37 100644
--- a/libraries/ghc-heap/GHC/Exts/Heap/Closures.hs
+++ b/libraries/ghc-heap/GHC/Exts/Heap/Closures.hs
@@ -347,7 +347,8 @@ allClosures (OtherClosure {..}) = hvalues
allClosures _ = []
#if __GLASGOW_HASKELL__ >= 809
--- | Get the size of a closure in words.
+-- | Get the size of the top-level closure in words.
+-- Includes header and payload. Does not follow pointers.
--
-- @since 8.10.1
closureSize :: Box -> Int