From 513f2daa9a3767d9535911276ffec772ab38b046 Mon Sep 17 00:00:00 2001 From: Xipmix <576337-xipmix@users.noreply.gitlab.com> Date: Sat, 9 Apr 2022 14:48:36 +1000 Subject: Remove full stop Unusual in headings and not done elsewhere in the document --- subplot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subplot.md b/subplot.md index f5dcbea..86084e0 100644 --- a/subplot.md +++ b/subplot.md @@ -463,7 +463,7 @@ action, or examination, but it's easier for humans reading the scenario, or writing the corresponding code, if each step only does the kind of work that is implied by the kind of step it's bound to. -### Using Subplot's language effectively. +### Using Subplot's language effectively Your subplot scenarios will be best understood when they use the subplot language in a fashion consistent with all subplot scenarios in your project(s). -- cgit v1.2.1 From 6009a09466c10e8f10ee275727baa854183f26a6 Mon Sep 17 00:00:00 2001 From: Xipmix <576337-xipmix@users.noreply.gitlab.com> Date: Sat, 9 Apr 2022 14:55:36 +1000 Subject: Reword opening sentence and tidy up related text On a first reading, this sentence seemed circular to me. After many, many rereadings, the only way I could interpret it was as shown here. Since the second paragraph is now repeating the first, prune it and rearrange the line break in the second sentence. --- subplot.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/subplot.md b/subplot.md index 86084e0..5dea8a2 100644 --- a/subplot.md +++ b/subplot.md @@ -466,15 +466,14 @@ the kind of work that is implied by the kind of step it's bound to. ### Using Subplot's language effectively Your subplot scenarios will be best understood when they use the subplot -language in a fashion consistent with all subplot scenarios in your project(s). +language in a consistent fashion, within and even across *different* projects. As with programming languages, it's possible to place your own style on your subplots, indeed there is no inherent internal implementation difference between how `given`, `when` and `then` steps are processed (other than that `given` steps often also have cleanup functions associated with them). -There is, however, value in having consistency between -the subplot scenarios in *different* projects. Here is how we recommend you use -the Subplot language, and indeed how we use it in Subplot and related projects… +Here is how we recommend you use the Subplot language, +and indeed how we use it in Subplot and related projects… When you are formulating your scenarios, it is common to try and use phraseology along the lines of _if this happens then that is the case_ but this is not -- cgit v1.2.1 From 32dd5f713bcf9980273c9e975f4e3d0d2a25af35 Mon Sep 17 00:00:00 2001 From: Xipmix <576337-xipmix@users.noreply.gitlab.com> Date: Sat, 9 Apr 2022 15:00:31 +1000 Subject: Break long sentence --- subplot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subplot.md b/subplot.md index 5dea8a2..5743def 100644 --- a/subplot.md +++ b/subplot.md @@ -468,7 +468,7 @@ the kind of work that is implied by the kind of step it's bound to. Your subplot scenarios will be best understood when they use the subplot language in a consistent fashion, within and even across *different* projects. As with programming languages, it's possible to place your own style on your -subplots, indeed there is no inherent internal implementation difference between +subplots. Indeed, there is no inherent internal implementation difference between how `given`, `when` and `then` steps are processed (other than that `given` steps often also have cleanup functions associated with them). -- cgit v1.2.1 From 2be516a2ba99074465e489ecd8af00697c9a27d0 Mon Sep 17 00:00:00 2001 From: Xipmix <576337-xipmix@users.noreply.gitlab.com> Date: Sat, 9 Apr 2022 15:02:18 +1000 Subject: Reword sentence after standing back and staring a bit --- subplot.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/subplot.md b/subplot.md index 5743def..69e0db8 100644 --- a/subplot.md +++ b/subplot.md @@ -472,8 +472,8 @@ subplots. Indeed, there is no inherent internal implementation difference betwe how `given`, `when` and `then` steps are processed (other than that `given` steps often also have cleanup functions associated with them). -Here is how we recommend you use the Subplot language, -and indeed how we use it in Subplot and related projects… +Nonetheless we have some recommendations about using the Subplot language, +which reflect how we use it in Subplot and related projects. When you are formulating your scenarios, it is common to try and use phraseology along the lines of _if this happens then that is the case_ but this is not -- cgit v1.2.1 From d3bdc9640bcfbea7a66f605ebd6b34acac5f5632 Mon Sep 17 00:00:00 2001 From: Xipmix <576337-xipmix@users.noreply.gitlab.com> Date: Sat, 9 Apr 2022 15:09:53 +1000 Subject: Comma to break sentence into contrasting options --- subplot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subplot.md b/subplot.md index 69e0db8..dc2499c 100644 --- a/subplot.md +++ b/subplot.md @@ -479,7 +479,7 @@ When you are formulating your scenarios, it is common to try and use phraseology along the lines of _if this happens then that is the case_ but this is not language which works well with subplot. Scenarios describe what will happen in the success case. As such we don't construct scenarios which say _if foo happens -then the case fails_ instead we say _when I do the thing then foo does not happen_. +then the case fails_, instead we say _when I do the thing then foo does not happen_. This is a subtle but critical shift in the construction of your test cases which will mean that they map more effectively to scenarios. -- cgit v1.2.1 From 307a37c2269058658a581838c31ab48d762d762c Mon Sep 17 00:00:00 2001 From: Xipmix <576337-xipmix@users.noreply.gitlab.com> Date: Sat, 9 Apr 2022 15:10:30 +1000 Subject: 'should be' feels wrong here, 'are' seems a better fit --- subplot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subplot.md b/subplot.md index dc2499c..5098d74 100644 --- a/subplot.md +++ b/subplot.md @@ -497,7 +497,7 @@ to inform the reader that some precondition is met. These statements are often best along the lines of `given a setup which works` or `given a development enviroment` or somesuch. -The `when` statements should be best used to denote **active** steps. These are +The `when` statements are best used to denote **active** steps. These are the steps which your putative actors or personae use to achieve their goals. These often work best in the form `when I do the thing` or `when the user does the thing`. -- cgit v1.2.1