diff options
Diffstat (limited to 'subplot.md')
| -rw-r--r-- | subplot.md | 24 |
1 files changed, 17 insertions, 7 deletions
@@ -509,7 +509,7 @@ could be of the form `then some output is present` or `then it exits successfull With all that in mind, a good scenario looks like -```scenario +``` given the necessary starting conditions when I do the required actions then the desired outcome is achieved @@ -628,6 +628,16 @@ This is still line number three, but would it be obvious? [roadmap]: https://crates.io/search?q=roadmap +### Use embedded file + +This scenario makes sure the sample files are used in a scenario so +that they don't cause warnings. + +~~~scenario +given file numbered-lines.txt +given file not-numbered-lines.txt +~~~ + ## Document metadata Pandoc supports, and Subplot makes use of, a [YAML metadata block][] in a @@ -809,7 +819,7 @@ given file badfilename.md and file b.yaml and file f.py and an installed subplot -when I run subplot docgen badfilename.md -o foo.pdf +when I run subplot docgen --merciful badfilename.md -o foo.pdf then file foo.pdf exists when I try to run subplot codegen --run badfilename.md -o test.py then command fails @@ -1182,7 +1192,7 @@ given file aliases.md given file b.yaml given file f.py given an installed subplot -when I run subplot docgen aliases.md -o aliases.html +when I run subplot docgen --merciful aliases.md -o aliases.html then command is successful then file aliases.html matches regex /given<[^>]*> precondition foo/ then file aliases.html matches regex /when<[^>]*> I do bar/ @@ -2572,7 +2582,7 @@ in a subplot. ~~~scenario given file embedded.md and an installed subplot -when I run subplot docgen embedded.md -o foo.html +when I run subplot docgen --merciful embedded.md -o foo.html then file foo.html exists and file foo.html matches regex /embedded\.txt/ ~~~ @@ -2753,7 +2763,7 @@ embedded files that aren't used. ~~~scenario given file unusedfile.md and an installed subplot -when I try to run subplot docgen unusedfile.md -o unusedfile.html +when I try to run subplot docgen --merciful unusedfile.md -o unusedfile.html then command is successful and file unusedfile.html exists and stderr contains "thisisnotused.txt" @@ -2894,7 +2904,7 @@ The `subplot metadata` command lists embedded files in its output. ~~~scenario given file two-embedded.md and an installed subplot -when I run subplot metadata two-embedded.md +when I run subplot metadata --merciful two-embedded.md then stdout contains "foo.txt" and stdout contains "bar.yaml" ~~~ @@ -3247,7 +3257,7 @@ It does not have a YAML metadata block. given file embedded-file.md and file expected.txt and an installed subplot -when I run subplot extract embedded-file.md foo.txt -d . +when I run subplot extract --merciful embedded-file.md foo.txt -d . then files foo.txt and expected.txt match ~~~ |