Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Semantics organisation #162

Closed
mnot opened this issue Oct 16, 2018 · 14 comments · Fixed by #291
Closed

Semantics organisation #162

mnot opened this issue Oct 16, 2018 · 14 comments · Fixed by #291

Comments

@mnot
Copy link
Member

mnot commented Oct 16, 2018

3. Conformance seems oddly separated from 1.1. Requirements Notation and 1.2. Syntax Notation; can we just move its contents up into 1?

Also, 11. ABNF List Extension: #rule seems like it's a natural for a peer or child of 1.2. Syntax Notation, rather than being buried between Response Header Fields and Security Considerations.

If that's all too much to put at the head of the document, could we perhaps move these things together to the end of the document (either one of the last sections, or as appendices), and just keep a skeleton referring to them at the top?

@reschke
Copy link
Contributor

reschke commented Oct 16, 2018

The list expansion once was an appendix, and we were told to move it up :-(

@mnot
Copy link
Member Author

mnot commented Nov 29, 2018

By whom?

@reschke
Copy link
Contributor

reschke commented Nov 29, 2018

During IESG review AFAIR.

@mnot
Copy link
Member Author

mnot commented Nov 29, 2018

I am tempted to try again; that's often just a matter of personal taste.

@royfielding
Copy link
Member

Conformance is where it is because of its usage of defined terms. It is much more important than it looks -- I don't want it in an appendix. I don't have an opinion on where the list extension belongs.

@mnot
Copy link
Member Author

mnot commented Jan 8, 2019

My proposal was to move Conformance to a new subsection of the introduction, to make it a peer of the requirements and syntax notations -- i.e., everything about "how to read this document" is in one place. That OK with you @royfielding?

Likewise, I wanted to move the list rule into a subsection of 1.2 Syntax Notation, since that's what it is.

@royfielding
Copy link
Member

But that means conformance would be making requirement statements about defined terms before the terms are actually defined. Is that okay? Or do we just need to split those sentences out?

@royfielding
Copy link
Member

Did you mean the entire section

https://httpwg.org/http-core/draft-ietf-httpbis-semantics-latest.html#conformance

or just some specific part of it? Moving the whole thing up doesn't make sense to me.

@mnot
Copy link
Member Author

mnot commented Jan 8, 2019

The whole thing. Too deep?

How about moving Conformance up above Architecture? (yes, this is getting towards choosing colours...)

@reschke
Copy link
Contributor

reschke commented Jan 8, 2019

Likewise, I wanted to move the list rule into a subsection of 1.2 Syntax Notation, since that's what it is.

Please don't. Too much prose in the wrong place. A forward reference is just fine.

@mnot
Copy link
Member Author

mnot commented Jan 8, 2019

Hmm, then see #187 (and comments there). Perhaps turn section 11 into a "generic syntax" bucket?

@reschke
Copy link
Contributor

reschke commented Jan 8, 2019

+1 to collecting generic syntax in a single place, in case it's really more than the whitespace part.

I'd separate common ABNF rules from the list extensions; these are different layers.

@mnot
Copy link
Member Author

mnot commented Jan 8, 2019

So, leave #rule as is, and add a new "Generic Syntax" section next to it?

@mnot mnot self-assigned this Jul 5, 2019
mnot added a commit that referenced this issue Sep 30, 2019
@mnot
Copy link
Member Author

mnot commented Sep 30, 2019

See PR. I think the remaining question is whether to move the contents of "Header Field Value Components" there as well (i.e., Tokens, Quoted Strings, Comments and Parameters.

reschke added a commit that referenced this issue Oct 19, 2019
@mnot mnot mentioned this issue Feb 3, 2020
@mnot mnot closed this as completed in #291 Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

3 participants