summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2020-09-02 10:12:31 +0300
committerLars Wirzenius <liw@liw.fi>2020-09-02 10:12:31 +0300
commit517c235c9dc2fffb412c04e6a70d9b32ae601e57 (patch)
treebfc1a2dc94b403cdccafdcca390ec0fd9e848573
parentc4f00e71e6124bacee46091942b3454895b2ad28 (diff)
downloadsubplot.liw.fi-517c235c9dc2fffb412c04e6a70d9b32ae601e57.tar.gz
wording clarifications from Daniel
-rw-r--r--tutorial.mdwn19
1 files changed, 11 insertions, 8 deletions
diff --git a/tutorial.mdwn b/tutorial.mdwn
index 0e4f293..50ae97a 100644
--- a/tutorial.mdwn
+++ b/tutorial.mdwn
@@ -14,8 +14,9 @@ an agreement of when a customer is required to pay for a project.
Acceptance testing differ from other integration testing by looking at
the software only from the user's point of view, not the developers'.
Because of this, Subplot produces two things: a standalone document
-aimed at the user to describe the accepance tests, and a report from
-executing the automated tests.
+aimed at the user to describe the accepance tests, and a test suite
+for developers to use to validate that the software meets those
+acceptance tests.
The document is meant to be a vehicle of communication between the
various stakeholders in a project, for specifying in detail what the
@@ -24,7 +25,8 @@ how they're verified, and makes it possible to do the verification
automatically.
Subplot generates the document, and a test program to execute the
-tests. Running the generated test program produces the test report.
+tests. Running the generated test program produces a test report which
+can be used as evidence of passing the tests.
# Architecture
@@ -160,13 +162,14 @@ file might look like this:
This means that for a step saying 'then standard output contains
"foo"', the Python function `stdout_is_text` is called and given the
-string `foo` as an argument.
+string `foo` as an argument called `text`.
The developers on the project, in collaboration with the testing team,
-need to supply the bindings and the Python functions. Subplot produces
-the code that extracts the interesting parts of scenario steps, and
-calls your functions in the right order, plus any other scaffolding
-needed.
+need to supply both the bindings and the implementation functions in
+whatever language the test suite is written in (Python in this
+example). Subplot produces the code that extracts the interesting
+parts of scenario steps, and calls your functions in the right order,
+plus any other scaffolding needed.
Installing Subplot