Re: [GHC] #11603: Fix/clarify documentation in GHC.Stats

#11603: Fix/clarify documentation in GHC.Stats -------------------------------------+------------------------------------- Reporter: dcturner | Owner: Type: task | Status: patch Priority: normal | Milestone: 8.0.1 Component: Core Libraries | Version: 8.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1929 Wiki Page: | -------------------------------------+------------------------------------- Comment (by Ben Gamari ): In [changeset:"8e19d3a3066b883d9bc10a75c8d3183907272a9f/ghc" 8e19d3a/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="8e19d3a3066b883d9bc10a75c8d3183907272a9f" base: A selection of fixes to the comments in GHC.Stats Use `-- |` comments throughout. Note that numByteUsageSamples is also the number of major GCs Note that numGcs counts GCs for all generations Note that 'current' really means 'at the end of the last major GC' Reviewers: ezyang, hvr, simonmar, austin, bgamari Reviewed By: ezyang, simonmar, bgamari Subscribers: thomie Differential Revision: https://phabricator.haskell.org/D1929 GHC Trac Issues: #11603 }}} -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11603#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler