From 40a34dc212a5749350723ac4f390335c0c5283e3 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Tue, 1 Nov 2016 10:30:34 +0200
Subject: Add note to testscript style guide

---
 doc/testscript.cli | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'doc')

diff --git a/doc/testscript.cli b/doc/testscript.cli
index e928d74..7ed9649 100644
--- a/doc/testscript.cli
+++ b/doc/testscript.cli
@@ -1449,9 +1449,10 @@ EOO
 \
 
 Separate multi-line tests with blank lines. You may want to place larger tests
-into explicit test scopes for better visual separation. In this case the
-description should come before the scope. Note that here-documents are
-indented as well. For example:
+into explicit test scopes for better visual separation (this is especially
+helpful if the test contains blank lines, for example, in here-document
+fragments). In this case the description should come before the scope. Note
+that here-documents are indented as well. For example:
 
 \
 : multi-name
@@ -1459,7 +1460,9 @@ indented as well. For example:
 {
   $* John Jane >>EOO
   Hello, John!
+
   Hello, Jane!
+
   EOO
 }
 \
-- 
cgit v1.1