Choose between semicolons and parenthesis #3591
Merged
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.
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
instead of
However, this doesn't touch the middle of sentences:
Suggestions welcome for the semicolon form of that.
There are other cases that don't quite seem to fit with semicolons, as well:
and this seems like it wouldn't want to split between two different styles:
One last example for this one:
And, finally, direct references without "see" too:
vs.
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.