httpwg / httpbis-issues

1 stars 1 forks source link

improve introduction of list rule #542

Closed mnot closed 3 years ago

mnot commented 3 years ago

Ted Lemon

Discuss (2013-12-18)

The list rule exception mentioned in section 1.2 confused the hell out of me until I got to section 7. Why is section 7 not a subsection of section 2? I assume the answer is "because it's long, and would suck the wind out of the document if it were at the beginning," which is fine, but if so, it would be nice if the text in 1.2 did a bit more foreshadowing. E.g.:

This specification uses the Augmented Backus-Naur Form (ABNF) notation of [RFC5234] with an extension defined in Section 7 that adds compact support for comma-separated lists with the addition of a # token to the usual ABNF token set, similar to the * token. Appendix B shows the collected ABNF with the list rule expanded.

Reported by julian.reschke@gmx.de; manually migrated from https://trac.ietf.org/trac/httpbis/ticket/542