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

Choose between semicolons and parenthesis #3591

Merged
merged 1 commit into from Apr 21, 2020

Conversation

erickinnear
Copy link
Contributor

This is beyond editorial, so skipping an issue for this, but since it came up in #3589.

Bikeshed time! Let's pick between semicolons and parenthesis.

This PR unifies the "see Section X.Y.Z" at the ends of sentences into the form

sentence words; see Section X.Y.Z.

instead of

sentence words (see Section X.Y.Z).

However, this doesn't touch the middle of sentences:

These are some sentence words (see Section X.Y.Z) about some stuff you should probably do.

Suggestions welcome for the semicolon form of that.

There are other cases that don't quite seem to fit with semicolons, as well:

- write data, understanding when stream flow control credit
  ({{data-flow-control}}) has successfully been reserved to send the written
  data;
- end the stream (clean termination), resulting in a STREAM frame
  ({{frame-stream}}) with the FIN bit set; and
- reset the stream (abrupt termination), resulting in a RESET_STREAM frame
  ({{frame-reset-stream}}), if the stream was not already in a terminal state.

and this seems like it wouldn't want to split between two different styles:

This section describes streams in terms of their send or receive components.
Two state machines are described: one for the streams on which an endpoint
transmits data ({{stream-send-states}}), and another for streams on which an
endpoint receives data ({{stream-recv-states}}).

One last example for this one:

A receiver sets initial credits for all streams by sending transport parameters
during the handshake ({{transport-parameters}}).  A receiver sends
MAX_STREAM_DATA ({{frame-max-stream-data}}) or MAX_DATA ({{frame-max-data}})
frames to the sender to advertise additional credit.

And, finally, direct references without "see" too:

as a connection error of type STREAM_LIMIT_ERROR (Section X.Y.Z).

vs.

as a connection error of type STREAM_LIMIT_ERROR; Section X.Y.Z.

So, for now, I've changed all of the "see Section X.Y.Z" form to use semicolons, as they were pretty split between the two already.

Either way we choose, happy to switch this up to match (it's not consistent either way, so no matter what a change is necessary), so this PR can be used to go in either direction.

@martinthomson martinthomson added -transport editorial An issue that does not affect the design of the protocol; does not require consensus. labels Apr 21, 2020
Copy link
Member

@martinthomson martinthomson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've been working toward this piecemeal. This helps a lot.

@ianswett
Copy link
Contributor

If we're going in this direction, we should update the other drafts as well(in subsequent PRs). I'm a fan of parens myself, but it's a bikeshed and I don't care that much.

@MikeBishop
Copy link
Contributor

I'm fine with leaving the parens mid-sentence. To me, the distinction is whether they're providing extra information about the entire sentence, or about a specific term in the sentence. If it's about a specific term, use parens immediately after the term; if it's about the sentence in general, use a semicolon after the sentence.

@erickinnear
Copy link
Contributor Author

Personally, I didn’t mind the parenthesis, but thanks @MikeBishop for putting some rationale together for mid vs. end of sentence refs like this — that sounds like a strategy I can live with.

@martinthomson martinthomson merged commit 1e4f3f5 into quicwg:master Apr 21, 2020
@martinthomson
Copy link
Member

Mike's rationale is excellent. Though I would add that the good practice of one concept per sentence leads to using a semicolon more often than not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
-transport editorial An issue that does not affect the design of the protocol; does not require consensus.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants