Merge branch 'smoke-test' into 'main'

Make it clearer that 'smoke test' and 'test data shared between scenarios' are closely related

See merge request subplot/subplot!260

1 files changed, 7 insertions, 5 deletions

diff --git a/subplot.md b/subplot.md
index 0a7b049..f5dcbea 100644
--- a/subplot.md
+++ b/subplot.md
@@ -994,10 +994,11 @@ 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 no need to be
+and clearer, but also so that the input files do not need to be
 duplicated for each scenario.
 
 ~~~~{#simple.md .file .markdown .numberLines}
@@ -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.