Skip to content

Commit 4d2489f

Browse files
authored
Merge pull request #1013 from rpottsoh/conventionCorrections
README.md: grammar corrections
2 parents 64a3b9f + 7286f3b commit 4d2489f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ There are three metadata files:
3030

3131
* `description.md` - the basic problem description
3232
* `metadata.yml` - additional information about the problem, such as where it came from
33-
* `canonical-data.json` (optional) - standardized test inputs and outputs that can be used to implement the problem
33+
* `canonical-data.json` - standardized test inputs and outputs that can be used to implement the problem
3434

3535
## Test Data Format (canonical-data.json)
3636

3737
This data can be incorporated into test programs manually or extracted by a
3838
program. The file format is described in `canonical-schema.json`, but it
39-
is easier to understand with a example:
39+
is easier to understand with an example:
4040

4141
```json
4242
{ "exercise": "foobar"
@@ -103,11 +103,11 @@ Keep in mind that the description should not simply explain **what** each case
103103
is (that is redundant information) but also **why** each case is there. For
104104
example, what kinds of implementation mistakes might this case help us find?
105105

106-
There are also some convention about `expected` that you must follow:
106+
There are also some conventions that must be followed:
107107

108108
- All keys should follow the [lowerCamelCase](http://wiki.c2.com/?LowerCamelCase) convention.
109-
- if the input is valid but there is no result for the input, the value at `"expected"` should be `null`.
110-
- if an error is expected (because the input is invalid, or any other reason), the value at `"expected"` should be an object containing exactly one property, `"error"`, whose value is a string.
109+
- If the input is valid but there is no result for the input, the value at `"expected"` should be `null`.
110+
- If an error is expected (because the input is invalid, or any other reason), the value at `"expected"` should be an object containing exactly one property, `"error"`, whose value is a string.
111111
- The string should explain why the error would occur.
112112
- A particular track's implementation of the exercise **need not** necessarily check that the error includes that exact string as the cause, depending on what is idiomatic in the language (it may not be idiomatic to check strings for error messages).
113113

@@ -165,7 +165,7 @@ PATCH changes would never break well-designed test generators, because the test
165165

166166
## Automated Tests
167167

168-
`canonical-data.json` for each exercise is checked for compliancy against the [canonical-schema.json](canonical-schema.json).
168+
`canonical-data.json` for each exercise is checked for compliance against the [canonical-schema.json](canonical-schema.json).
169169
In order to run these tests, you will need to have `node` and `npm` installed on your system.
170170
Install them from [here](https://nodejs.org/en/). (`npm` comes bundled with most installations of `node`).
171171

0 commit comments

Comments
 (0)