qcram: section reference format #1112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
afrind
reviewed
Feb 20, 2018
| @@ -362,7 +362,7 @@ the number of concurrently blocked streams. | |||
|
|
|||
| ### Fixed overhead. | |||
|
|
|||
| HPACK defines overhead as 32 bytes ({{!RFC7541}} Section 4.1). As described | |||
| HPACK defines overhead as 32 bytes ({{!RFC7541}}, Section 4.1). As described | |||
There was a problem hiding this comment.
Is there a consistent format we should use for references to RFC7541? Or it's ok that one is 'see Section X.Y of' and the other is ', Section X.Y'?
There was a problem hiding this comment.
I have been using "Section X.Y of {{CITATION}}" always. The other acceptable form is "{{CITATION}}, Section X.Y", but there is value in consistency.
There was a problem hiding this comment.
...depends on context. The first form works a bit better in prose, the second one in parentheses. IMHO.
| @@ -103,7 +103,7 @@ PUSH_PROMISE frames (see {{hq-frames}}). | |||
| If a header block contains no vulnerable header fields, BLOCKING MUST be 0. | |||
| This implies that the header fields are represented either as references | |||
| to dynamic table entries which are known to have been received, or as | |||
| Literal header fields (see {{RFC7541}} Section 6.2). | |||
| Literal header fields (see Section 6.2 of {{RFC7541}} ). | |||
There was a problem hiding this comment.
Is there an extraneous space before ) ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.