Dhall.Pretty.layout: Add comment regarding whitespace stripping (#1538)

2019-11-14 20:02:46 +01:00 · 2019-11-14 20:02:46 +01:00 · f18ec5f8e0
parent 53320c8e19
commit f18ec5f8e0
1 changed files with 3 additions and 0 deletions
--- a/dhall/src/Dhall/Pretty/Internal.hs
+++ b/dhall/src/Dhall/Pretty/Internal.hs
@ -1182,6 +1182,9 @@ prettyToStrictText = docToStrictText . Pretty.pretty
 -- | Layout using 'layoutOpts'
 --
 -- Tries hard to fit the document into 80 columns.
+--
+-- This also removes trailing space characters (@' '@) /unless/
+-- they are enclosed in an annotation.
 layout :: Pretty.Doc ann -> Pretty.SimpleDocStream ann
 layout = Pretty.removeTrailingWhitespace . Pretty.layoutSmart layoutOpts