aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-11-01 10:30:34 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-11-04 09:26:37 +0200
commit40a34dc212a5749350723ac4f390335c0c5283e3 (patch)
treecd8e622b4dab0a29bbd0dd4d9dd0f0b70b6376bd
parent7f6808984dfb37848edf149c34242f7163eb1a17 (diff)
Add note to testscript style guide
-rw-r--r--doc/testscript.cli9
1 files changed, 6 insertions, 3 deletions
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
}
\