Typos

Laurent Lyaudet <[email protected]> Wed, 30 Mar 2016 15:39:34 +0200
Newsgroups gmane.text.yaml.general
Message-ID <[email protected]>
Hi,

Thanks for creating YAML.

I have read YAML 1.2 specification (in pdf format) and found the 
following typos and minor errors.
I have also a few remarks/questions.

- section "3.2.3 Presentation Stream" "of" is repeated on line 1 "making 
use of of styles"

- section "3.2.3.1 Node Styles"
-- on line 2 the semicolon is followed by a capital letter "; In contrast".
   I'm not a native english speaker but I have found there:
http://www.grammarly.com/handbook/punctuation/semicolon/1/semicolon-use/
   that there shouldn't be a capital letter.

-- "styles" is repeated on line 3 "flow styles styles rely on"

- section "3.2.3.4 Directives" "a" should be removed in "defines a two 
directives"

- section "5.1 Character Set" Maybe I've misunderstood something but you 
say explicitly that "JSON quoted scalars cannot [...] contain tabs".
Nevertheless, you list tab "#x9" in rule [2] that defines nb-json. 
Should-it be renamed "nb-yaml" or should the "#x9" be removed?
If not, can you clarify please?

- section "5.2 Character Encodings" 4th paragraph, "as" is repeated in 
"to be as as indicated"

- "Example 5.11 Line Break Characters" There is a capital 'L' on the 
left for the two "Line", while it is "line" on the right.

- section "6.8.2.2 Tag Prefixes", "Global Tag prefix" paragraph, "to" 
should be removed in "it must to be a valid".

- "Example 6.27 Invalid Tag Shorthands" there is "!e!" on the left and 
"!o!" on the right.

- line 1 below "Example 7.4 Double Quoted Implicit Keys" "are" is 
repeated in "line breaks are are subject to flow"

- "Example 7.16 Flow Mapping Entries" it seems to me that the 
lines/dashes around the tokens are exchanged between the example and the 
legend/caption.
"ns-flow-map-explicit-entry(n,c)" should be 
"ns-flow-map-implicit-entry(n,c)" and vice-versa.

- rules [154] and [155] What is "a" in "n/a" ?

- rule [162] It would be great to recall what "m" and "t" are just 
before rule [162], since it is the first time they are used and a long 
time after they were introduced in advance in section 4.1.

- according to section "8.1.1.1" the indentation indicator is relative 
to the indentation level of the parent node.
For me, in "Example 8.2" the parent node is the "seq" with indentation 
level 0.
Hence, the indentation indicator for "explicit" should be 2 instead of 1.
Am I correct ? If not, where do I make an error ?

- "Example 8.5" Maybe it would be clearer to add ".." before "#text" in 
order to see immediately the indentation level ?

- "Example 8.10 Folded Lines, 8.11, 8.12, and 8.13" There is a missing 
"\", "* bullet \n" should be "* bullet \n\".

- rule [181], the name "l-nb-diff-lines(n)" is not clear.
The sentence "Line breaks 
<http://www.yaml.org/spec/1.2/spec.html#line%20break//> and empty lines 
<http://www.yaml.org/spec/1.2/spec.html#empty%20line//> separating 
folded and more-indented lines are also not folded 
<http://www.yaml.org/spec/1.2/spec.html#line%20folding//>. "
suggests that you will distinguish when  a change occurs between folded 
and more-indented lines.
However it's exactly what the rule [181] doesn't detect, since the lines 
can be different but they don't have to be different.
Can you rename "l-nb-diff-lines(n)" to something like 
"l-nb-maybe-diff-lines(n)" or add an explanation to help the reader?

- "Example 8.14 Block Sequence" "auto-detected s-indent(n)" in the 
legend/caption is not used.

- "Example 9.6 Stream" "l-document-suffix" in the legend/caption is not 
used, it should be for "...".

- section "10.2.1.4" "Canonical Form" Is-it possible to put the regular 
expression on its own line for the pdf (it's fine for the html).

- "Example 10.9" Is-it possible to put "!!float \".5\"," on its own line 
for the pdf (it's fine for the html).

- Last but not least, you write "The order of alternatives inside a 
production is significant. [...]"
It appears that the JSON alternative is listed last in a few cases. 
Is-it intentional?
I thought that it would be listed first since it's more restrictive and 
it would enable "one-pass double-validation"
(the document is valid YAML 1.2 and is also valid JSON or not).
  Example : rule [158] YAML is before JSON. However in "Example 7.23 
Flow Content" the tokens are "legended/captioned" in priority with 
"c-flow-json-content(n,c)"
instead of "ns-flow-yaml-content(n,c)". idem for "Example 7.24 Flow Nodes".

That's all for the specification.

I also noted that http://yaml.org/type/ says "YAML 1.1".
It should also list YAML 1.2.


Best regards,
   Laurent Lyaudet

------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with
Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785471&iu=/4140

_______________________________________________
Yaml-core mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/yaml-core