Skip to content

Commit 1619163

Browse files
committed
A bit less informal language in the README.
1 parent 71f55b3 commit 1619163

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ choice is still the job of the validator implementor.
1212
Structure of a Test
1313
-------------------
1414

15-
If you're going to use this suite, you need to know how tests are laid out. The
16-
tests are contained in the `tests` directory at the root of this repository.
15+
The tests in this suite are contained in the `tests` directory at the
16+
root of this repository.
1717

1818
Inside that directory is a subdirectory for each draft or version of the
19-
schema.
19+
specification.
2020

21-
If you look inside the draft directory, there are a number of `.json` files,
22-
which logically group a set of test cases together. Often the grouping is by
23-
property under test, but not always, especially within optional test files
24-
(discussed below).
21+
Inside each draft directory, there are a number of `.json` files, which
22+
logically group a set of test cases together. Often the grouping is by
23+
property under test, but not always, especially within optional test
24+
files (discussed below).
2525

2626
Inside each `.json` file is a single array containing objects. It's easiest to
2727
illustrate the structure of these with an example:
@@ -45,9 +45,10 @@ illustrate the structure of these with an example:
4545
}
4646
```
4747

48-
So a description, a schema, and some tests, where tests is an array containing
49-
one or more objects with descriptions, data, and a boolean indicating whether
50-
they should be valid or invalid.
48+
In short: a description, a schema under test, and some tests, where each
49+
test in the `tests` array is an objects with a description of the case
50+
itself, the instance under test, and a boolean indicating whether it
51+
should be valid or invalid.
5152

5253
Coverage
5354
--------

0 commit comments

Comments
 (0)