Skip to content

Commit c151549

Browse files
committed
Gave the reader/writer test section a makeover.
1 parent d61fa29 commit c151549

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -174,21 +174,23 @@ Adding a reader/writer test
174174
---------------------------
175175

176176
To add a test, you need to create two files in test/data:
177-
- a TESTNAME.json file, that contains the input document in JSON format.
178-
- a TESTNAME.expected file, that contains a flatened representation of
179-
the input document.
180-
181-
TESTNAME.expected file format:
182-
- each line represents a JSON element of the element tree represented
183-
by the input document.
184-
- each line has two parts: the path to access the element separated from
185-
the element value by '='. Array and object values are always empty
186-
(e.g. represented by either [] or {}).
187-
- element path: '.' represented the root element, and is used to separate
188-
object members. [N] is used to specify the value of an array element
189-
at index N.
190-
See test_complex_01.json and test_complex_01.expected to better understand
191-
element path.
177+
178+
* a `TESTNAME.json` file, that contains the input document in JSON format.
179+
* a `TESTNAME.expected` file, that contains a flatened representation of the
180+
input document.
181+
182+
The `TESTNAME.expected` file format is as follows:
183+
184+
* each line represents a JSON element of the element tree represented by the
185+
input document.
186+
* each line has two parts: the path to access the element separated from the
187+
element value by `=`. Array and object values are always empty (i.e.
188+
represented by either `[]` or `{}`).
189+
* element path: `.` represents the root element, and is used to separate object
190+
members. `[N]` is used to specify the value of an array element at index `N`.
191+
192+
See the examples `test_complex_01.json` and `test_complex_01.expected` to better
193+
understand element paths.
192194

193195

194196
Understanding reader/writer test output

0 commit comments

Comments
 (0)