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

This commit is contained in:
Simon Jakobi 2019-11-14 20:02:46 +01:00 committed by mergify[bot]
parent 53320c8e19
commit f18ec5f8e0

View File

@ -1182,6 +1182,9 @@ prettyToStrictText = docToStrictText . Pretty.pretty
-- | Layout using 'layoutOpts' -- | Layout using 'layoutOpts'
-- --
-- Tries hard to fit the document into 80 columns. -- 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.Doc ann -> Pretty.SimpleDocStream ann
layout = Pretty.removeTrailingWhitespace . Pretty.layoutSmart layoutOpts layout = Pretty.removeTrailingWhitespace . Pretty.layoutSmart layoutOpts