quicwg / base-drafts

Internet-Drafts that make up the base QUIC specification
https://quicwg.org
1.63k stars 204 forks source link

Auth48: Capitalization and terminology consistency #4976

Closed LPardue closed 2 years ago

LPardue commented 2 years ago

We had the following questions related to the terminology used in this document.

a) Throughout the text, the following terminology appears to be used inconsistently. Please review these occurrences and let us know if/how they may be made consistent.

base vs. Base post-base vs. Post Base length vs. Length delta vs. Delta Base

b) We have updated the following terminology to use the form on the right consistently to match what we feel was the intended use. Please review and let us know any objections.

Instruction / instruction (e.g., Insert Count Increment instructions)

c) We see the use of both "single pass" and "one pass" in this document. Please review if these should be made uniform.

MikeBishop commented 2 years ago

60 occurrences of "Base" vs. 31 occurrences of "base". Of those 31 lowercase instances, 22 of them are not part of the normal prose (e.g. pseudocode, section anchors, etc.) or aren't referring to this concept (e.g. "length-based", "based on"). Of the remaining nine, eight are occurrences of "post-base." Pretty clearly, our convention (deliberate or not) has been to capitalize this term.

That doesn't mesh with the rest of the QUIC documents, where the convention has been to capitalize field names, not terminology. One could argue that Base is effectively a field, albeit one encoded on the wire as the sum/difference of two other values; of course, one could say the same of the QUIC packet number and we didn't capitalize that.

The term "post-base" is uniformly not capitalized, except that "Post-Base" is used in the following two situations:

These two conventions don't align with each other. We should align on either "Base"/"post-Base" or "base"/"post-base".

MikeBishop commented 2 years ago

"Length" is capitalized in several difference situations in the prose:

It seems to me that the first should be fixed while the second is fine. The third might benefit from a different means of indicating the size of the field, but it's not as obvious.

MikeBishop commented 2 years ago

"delta" vs. "Delta Base" is used correctly, since "Delta Base" uniformly refers to the field. Lowercase "delta" is used in one instance to refer to the difference being encoded here; we could improve clarity by not using this term or by referring to the field.

MikeBishop commented 2 years ago

I don't see any instances of (capitalized) "Instruction" in the document which aren't title-cased or the first word of a sentence. That's fine.

The one instance of "One Pass" could be normalized to "Single Pass" without issue.

MikeBishop commented 2 years ago

Fixed in #4989.