From f18ec5f8e0145f8c77a3d59fedd8d0934c0e1bc0 Mon Sep 17 00:00:00 2001
From: Simon Jakobi <simon.jakobi@gmail.com>
Date: Thu, 14 Nov 2019 20:02:46 +0100
Subject: [PATCH] Dhall.Pretty.layout: Add comment regarding whitespace
 stripping (#1538)

---
 dhall/src/Dhall/Pretty/Internal.hs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/dhall/src/Dhall/Pretty/Internal.hs b/dhall/src/Dhall/Pretty/Internal.hs
index 2b1a452..0770093 100644
--- 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