Skip to content

Commit ceb17dd

Browse files
authored
Allow comments in JSON without space padding. (#2596)
1 parent 818d503 commit ceb17dd

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -72,21 +72,25 @@ The file format is described in [canonical-data.schema.json](./canonical-data.sc
7272
" languages. ",
7373
" ",
7474
" In addition to a mainstream implementation path, this information ",
75-
" can also document significant variations. "
75+
" can also document significant variations. ",
76+
" ",
77+
" Space padding comments can make them a bit easier to read but is ",
78+
" not required. ",
79+
" "
7680
],
7781
"cases": [
7882
{
7983
"comments": [
80-
" A test case must have 'uuid', 'description', 'property', ",
81-
" 'input' and 'expected' properties. The rest is optional. ",
82-
" ",
83-
" The 'property' is a string in lowerCamelCase identifying ",
84-
" the type of test, but most of the times it is just the ",
85-
" name of a function being tested. ",
86-
" ",
87-
" Test cases can have any number of additional keys, and ",
88-
" most of them also have an 'expected' one, defining the ",
89-
" value a test should return. "
84+
"A test case must have 'uuid', 'description', 'property',",
85+
"'input' and 'expected' properties. The rest is optional.",
86+
"",
87+
"The 'property' is a string in lowerCamelCase identifying",
88+
"the type of test, but most of the times it is just the",
89+
"name of a function being tested.",
90+
"",
91+
"Test cases can have any number of additional keys, and",
92+
"most of them also have an 'expected' one, defining the",
93+
"value a test should return."
9094
],
9195
"uuid": "31e9db74-86b9-4b14-a320-9ea910337289",
9296
"description": "Foo'ing a word returns it reversed",
@@ -108,8 +112,8 @@ The file format is described in [canonical-data.schema.json](./canonical-data.sc
108112
},
109113
{
110114
"comments": [
111-
" Test cases can be arbitrarily grouped with a description ",
112-
" to make organization easier. "
115+
"Test cases can be arbitrarily grouped with a description",
116+
"to make organization easier."
113117
],
114118
"description": "Abnormal inputs: numbers",
115119
"cases": [

0 commit comments

Comments
 (0)