Add scenarios to example and describe purpose (#1683)

wolf99 · web-flow · commit 126568d7bddc · 2020-10-13T13:42:46.000+02:00
diff --git a/README.md b/README.md
@@ -115,6 +115,7 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)
                 "word"       : "28948022309329048855892746252171976962977213799489202546401021394546514198529"
               }
             , "expected"   : null
+            , "scenarios"  : [ "big-integers" ]
             }
           , { "uuid"       : "c7b6f24a-553f-475a-8a40-dba854fe1bff"
             , "description": "Bar'ing a name with numbers gives an error"
@@ -133,6 +134,8 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)
 
 ## Scenarios
 
+An optional field to allow for selectively including/excluding test cases based on a property of the test case (such as using big integers).
+
 - The `scenarios` field can use one or more of a predefined set of values, which are defined in a [`SCENARIOS.txt`](./SCENARIOS.txt) file.
 - The `scenarios` field can be mutated additively, by adding new scenarios. Existing scenarios must not be changed or removed. Adding new scenarios does therefore does not mean adding a new test case.
 - Library tests should have a `library-test` scenario added to allow for easy including/excluding of library tests. Application tests won't have their own scenario, as they must be included and should not be filtered on.

Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,7 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)`
`115`	`115`	`"word" : "28948022309329048855892746252171976962977213799489202546401021394546514198529"`
`116`	`116`	`}`
`117`	`117`	`, "expected" : null`
	`118`	`+ , "scenarios" : [ "big-integers" ]`
`118`	`119`	`}`
`119`	`120`	`, { "uuid" : "c7b6f24a-553f-475a-8a40-dba854fe1bff"`
`120`	`121`	`, "description": "Bar'ing a name with numbers gives an error"`
`@@ -133,6 +134,8 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)`
`133`	`134`
`134`	`135`	`## Scenarios`
`135`	`136`
	`137`	`+An optional field to allow for selectively including/excluding test cases based on a property of the test case (such as using big integers).`
	`138`	`+`
`136`	`139`	- The `scenarios` field can use one or more of a predefined set of values, which are defined in a [`SCENARIOS.txt`](./SCENARIOS.txt) file.
`137`	`140`	- The `scenarios` field can be mutated additively, by adding new scenarios. Existing scenarios must not be changed or removed. Adding new scenarios does therefore does not mean adding a new test case.
`138`	`141`	- Library tests should have a `library-test` scenario added to allow for easy including/excluding of library tests. Application tests won't have their own scenario, as they must be included and should not be filtered on.