summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--yarn.1.in6
1 files changed, 5 insertions, 1 deletions
diff --git a/yarn.1.in b/yarn.1.in
index 2d40dfc..d1789b1 100644
--- a/yarn.1.in
+++ b/yarn.1.in
@@ -37,6 +37,7 @@ As an example, consider a very short test scenario for verifying that
a backup program works, at least for one simple case.
.IP
.nf
+SCENARIO backups can be restored
GIVEN some live data in a directory
AND an empty backup repository
WHEN a backup is made
@@ -44,7 +45,8 @@ THEN the data case be restored
.nf
.PP
(Note the addition of AND: you can have multiple GIVEN, WHEN, and
-THEN statements. The AND keyword makes the text be more readable.)
+THEN statements. The AND keyword makes the text be more readable.
+SENCARIO is also necessary, and gives the title.)
.PP
Scenarios are meant to be written in somewhat human readable language.
However, they are not free form text.
@@ -113,3 +115,5 @@ All the files will be treated together as if they had been one file.
.SH "SEE ALSO"
.BR cmdtest (1),
.BR cliapp (5).
+.PP
+The README.yarn file has more details on the scenario testing language.