Confusing Notes and Examples: There appears to be no consistent editorial principle applied to distinguish between notes and examples in the text. Text that looks like examples appear in notes and what are probably notes appear in examples with no distinguishable principle for the use of one over the other.

The document should be amended to consistently and on the basis of some principle to distinguish between examples and notes. As specified by the ISO/IEC Directives, Part 2, §6.5.1, note and example elements shall not contain requirements or any information considered indispensable for the use of the document." That is, there should not be any normative requirements specified only in a note or example.

Throughout DIS 29500

ed

Proposed Disposition of DIS 29500 Comment US-0266 (Modified: 2008-01-04) Each note and example has its own set of corresponding delimiters, and each is consistently used. Our editorial style is that a delimited note should not contain a delimited example, and vice versa. However, occasionally, it is useful to add “note text” at the start and/or end of what is primarily an example, and to add an example in the middle or end of a note. We see no problem with this. Given that all notes and examples are informative, we believe that the concern here is about style, and one that is subjective. A large and growing number of people are implementing the specification as is, and, apart from this comment, we have received no feedback from them that our use of notes and examples is confusing. That said, if anyone can cite specific instances, we’d be happy to review them. We agree that normative requirements should not occur in notes or examples, and, separately, we have addressed each NB comment that has pointed out a violation of this principle.

Tag and Go

No Comments

Leave a comment

XHTML: You can use these tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <code> <em> <i> <strike> <strong>

  • Argentina (1)
  • Australia (30)
  • Austria (1)
  • Belgium (1)
  • Brazil (64)
  • Bulgaria (3)
  • Canada (79)
  • Chile (217)
  • China (1)
  • Colombia (237)
  • Czech Republic (75)
  • Denmark (168)
  • Ecma (76)
  • Ecuador (1)
  • Finland (15)
  • France (592)
  • Germany (162)
  • Ghana (12)
  • Greece (113)
  • India (82)
  • Iran (58)
  • Ireland (12)
  • Israel (33)
  • Italy (2)
  • Japan (82)
  • Jordan (1)
  • Kenya (81)
  • Malaysia (23)
  • Malta (5)
  • Mexico (7)
  • New Zealand (54)
  • Norway (12)
  • Peru (10)
  • Philippines (7)
  • Poland (4)
  • Portugal (118)
  • Singapore (2)
  • South Africa (17)
  • South Korea (25)
  • Spain (1)
  • Switzerland (19)
  • Thailand (1)
  • Tunisia (3)
  • Turkey (1)
  • UK (635)
  • Uruguay (18)
  • USA (288)
  • Venezuela (73)