archives

« Bugzilla Issues Index

#4397 — inconsistent formatting of Notes


The spec usually formats multi-line Notes as hanging paragraphs: the second and subsequent lines are indented to left-align with the first word of the body of the Note.

Here are sections containing Notes that are not formatted that way. That is, the second and subsequent lines are left-aligned with the 'N' of 'NOTE':
6.2.3
9.2.12
9.4.2.4
12.1.1
12.1.5
13.3.1
13.3.2
13.3.3.5
13.3.3.6
13.3.3.7
13.10
13.11
13.13
13.16.1
14.1.18
14.2.14
15.1.8


fixed and in Word source and updated PDF has been pushed to the ECMA website.

Note that the problem didn't appear in the HTML version or it wasn't change.


(In reply to Allen Wirfs-Brock from comment #1)
> fixed and in Word source and updated PDF has been pushed to the ECMA website.

Yup, those appear to be fixed EXCEPT for 6.2.3.


Here are some other things I noticed relating to Note formatting:

In 12.3.2:
(a) The formatting is odd, with the productions indented less than the prose they're embedded in.

(b) But it's all indented wrt the "NOTE", which indicates that the entire content of the section is a Note. But surely most (if not all?) of that section is normative.


In 15.1.8:
(a) There are two Notes, so they should presumably be numbered.

(b) The very last paragraph is formatted strangely, and should maybe be part of the preceding Note, or else a separate Note.


(Also, in 8.1.1.5.2, the Note is not a complete sentence, though that's not a formatting problem.)


corrected in final (June 21, 2015) Ecma distribution update