diff options
author | Xipmix <576337-xipmix@users.noreply.gitlab.com> | 2022-03-16 21:04:37 +1100 |
---|---|---|
committer | Xipmix <576337-xipmix@users.noreply.gitlab.com> | 2022-03-16 21:06:17 +1100 |
commit | 8ffe2299743e4a0f745fd72fce2bf62b4722824f (patch) | |
tree | 2c01768770e382fd72c4a8711a66b339e196ea43 /subplot.md | |
parent | a50f1c5133814011f9ca1bb97d15976c7e623585 (diff) | |
download | subplot-8ffe2299743e4a0f745fd72fce2bf62b4722824f.tar.gz |
trailing space in other places
Diffstat (limited to 'subplot.md')
-rw-r--r-- | subplot.md | 24 |
1 files changed, 12 insertions, 12 deletions
@@ -30,7 +30,7 @@ correspond to use cases. The scenario as accompanied by explanatory text to explain things to the reader. Scenarios use a given/when/then sequence of steps, where each step is implemented by code provided by the developers of the system under test. This is very similar to the -[Cucumber][] tool, but with more emphasis of producing a standalone +[Cucumber][] tool, but with more emphasis on producing a standalone document. [Cucumber]: https://en.wikipedia.org/wiki/Cucumber_(software) @@ -71,7 +71,7 @@ you can vary based on your particular needs and circumstances. 3. Write scenarios to verify that the criteria are met, and have those scenarios agreed by the stakeholders. 4. Write bindings and test functions, so that as the code is written - it can be tested against the acceptance criteria. + it can be tested against the acceptance criteria. 5. Iterate on this in short cycles to maximise discussion and stakeholder buy-in. @@ -85,7 +85,7 @@ Subplot reads an input document, in Markdown, and generates a typeset output document, as PDF or HTML, for all stakeholders to understand. Subplot also generates a test program, in Python, that verifies the acceptance criteria are met, for developers and testers and auditors -to verify the sustem under test meets its acceptance criteria. The +to verify the system under test meets its acceptance criteria. The generated program uses code written by the Subplot user to implement the verification steps. The graph below illustrates this and shows how data flows through the system. @@ -134,7 +134,7 @@ be requested by the user. Depending on the output format, Pandoc may use, for example, LaTeX. Subplot interprets parts of the Markdown input file itself. -Subplot actually consists mainly of two separate programs: +Subplot actually consists mainly of two separate programs: **subplot docgen** for generating output documents, and **subplot codegen** for generating the test program. There are a couple of additional tools (**subplot metadata** for reporting meta data about a Subplot document, and @@ -546,7 +546,7 @@ will deal with formatting that nicely for you. Subplot uses [Pandoc][], the universal document converter, to parse the Markdown file, and thus understands the variants of Markdown that Pandoc supports. This includes traditional Markdown, CommonMark, and -GitHub-flavored Markdown. +GitHub-flavored Markdown. [fenced code blocks]: https://pandoc.org/MANUAL.html#fenced-code-blocks @@ -2342,7 +2342,7 @@ given file dateless.md and an installed subplot when I run subplot docgen dateless.md -o dateoption.html --date=FANCYDATE then file dateoption.html exists -and file dateoption.html contains "<title>The Fabulous Title</title>" +and file dateoption.html contains "<title>The Fabulous Title</title>" and file dateoption.html contains "Alfred Pennyworth" and file dateoption.html contains "Geoffrey Butler" and file dateoption.html contains "FANCYDATE" @@ -2470,7 +2470,7 @@ then JSON output matches expected.json ~~~{#images.md .file .markdown .numberLines} --- title: Document refers to external images -bindings: +bindings: - b.yaml - other.yaml impls: @@ -2561,7 +2561,7 @@ to the code blocks, with one of three allowed cases: * `add-newline=yes`—always add a newline, even if one is already there -The scenarios below test the various cases. +The scenarios below test the various cases. ### Extract embedded file @@ -3071,14 +3071,14 @@ finished: ready: status: ready label: | - This task is ready + This task is ready to be done: it is not blocked by anything next: status: next label: | - This task is chosen + This task is chosen to be done next blocked: @@ -3130,14 +3130,14 @@ finished: ready: status: ready label: | - This task is ready + This task is ready to be done: it is not blocked by anything next: status: next label: | - This task is chosen + This task is chosen to be done next blocked: |