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

[format.parse.ctx] add comma before 'which' #6816

Merged
merged 1 commit into from Feb 22, 2024

Conversation

Eisenwave
Copy link
Contributor

Normally, you would write a comma here.

Saying

indexing == manual is true which

suggests that index == manual is the true which ...

This wouldn't make sense since there is only one true, which makes it more correct to write a comma here. Of course, the sentence is unambiguous one way or the other; this is purely a readability improvement.

Copy link
Member

@jwakely jwakely left a comment

Choose a reason for hiding this comment

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

I don't agree that without the comma it suggests "the true which". The definite article is not implicit there, and adding it changes the meaning completely. I do think this is a slight improvement, but the same change should be done on line 17383. Change both, or neither.

We could even move the explanation into a note:

[Note: Calling this function when indexing_ == manual is true indicates mixing of ... ]

So the normative part just says what+when it throws, and the note explains why the condition is an error. Just adding commas is fine though.

@Eisenwave
Copy link
Contributor Author

image

I favor the solution which converts the non-normative part into a note.

Also, I believe that it's sufficient to say "This indicates ...". Firstly, the stakes are low since this isn't normative wording anyway. Secondly, no matter whether the reader thinks that "This" refers to

  • calling the function with the condition being true, or
  • an error being thrown,

the reading is correct. I don't think the verbosity of "Calling this function when indexing == manual is true indicates ..." is required.

@jensmaurer jensmaurer merged commit 8c8e05d into cplusplus:main Feb 22, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants