Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC

Commits:

1 changed file:

Changes:

  • libraries/ghc-experimental/src/GHC/Stack/Annotation/Experimental.hs
    ... ... @@ -17,6 +17,7 @@
    17 17
     -- the user to gain more control over what an IPE stack trace looks like.
    
    18 18
     --
    
    19 19
     -- The main advantages of stack frame annotations over other 'Backtraces':
    
    20
    +--
    
    20 21
     -- * Function signatures don't need to be modified to improve stack traces (e.g. via 'HasCallStack').
    
    21 22
     -- * Annotation are arbitrary user-defined datatypes, not just source locations.
    
    22 23
     -- * Stack frame annotations are always present and do not require recompilation (e.g. @-prof@ or @-g3@).
    
    ... ... @@ -39,7 +40,7 @@ module GHC.Stack.Annotation.Experimental (
    39 40
       annotateCallStackIO,
    
    40 41
       -- * Push stack frame annotations in non-'IO' code.
    
    41 42
       --
    
    42
    -  -- These variants all evaluate the code to be annotated to WHNF.
    
    43
    +  -- | These variants all evaluate the code to be annotated to WHNF.
    
    43 44
       -- Otherwise, the stack annotations will not be shown in stack traces,
    
    44 45
       -- as the computation is immediately "evaluated" to a thunk, popping the
    
    45 46
       -- annotation frames from the stack.