summaryrefslogtreecommitdiff
path: root/subplot.md
diff options
context:
space:
mode:
authorXipmix <576337-xipmix@users.noreply.gitlab.com>2022-03-21 23:44:38 +1100
committerXipmix <576337-xipmix@users.noreply.gitlab.com>2022-03-23 20:17:45 +1100
commit390164b6179f64bd2fc5a1eeb30cd5b90600d065 (patch)
treeb5cb2a0b9318ed55ba4f94740d9ac850243a0383 /subplot.md
parentb5ceeb7928b6e0508cb7abe4a41bfcc4aa44b102 (diff)
downloadsubplot-390164b6179f64bd2fc5a1eeb30cd5b90600d065.tar.gz
Clarify these two sections are closely related
Diffstat (limited to 'subplot.md')
-rw-r--r--subplot.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/subplot.md b/subplot.md
index 34efe0f..f5dcbea 100644
--- a/subplot.md
+++ b/subplot.md
@@ -994,8 +994,9 @@ Add the acceptance criteria test scenarios for Subplot here.
## Test data shared between scenarios
-The scenarios below test Subplot by running it against specific input
-files. This section specifies the bindings and functions files.
+The 'smoke-test' scenarios below test Subplot by running it against specific input
+files. This section specifies the bindings and functions files, which
+are generated and cleaned up on the fly.
They're separate from the scenarios so that the scenarios are shorter
and clearer, but also so that the input files do not need to be
duplicated for each scenario.
@@ -1075,9 +1076,10 @@ def foobar_was_done(ctx):
~~~
-## Smoke test
+### Smoke test
-This tests that Subplot can build a PDF and an HTML document, and
+The scenario below uses the input files defined above to run some tests
+to verify that Subplot can build a PDF and an HTML document, and
execute a simple scenario successfully. The test is based on
generating the test program from an input file, running the test
program, and examining the output.