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

[tab:container.hash.req] Capitalize start of sentence. #4271

Merged
merged 1 commit into from Oct 18, 2020

Conversation

jensmaurer
Copy link
Member

@jensmaurer jensmaurer commented Oct 2, 2020

Fixes #4269

@@ -1728,7 +1728,7 @@

\indexordmem{node_type}%
\tcode{X::node_type} &
a specialization of a \exposid{node-handle}
A specialization of a \exposid{node-handle}
Copy link
Contributor

Choose a reason for hiding this comment

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

This is technically not a sentence - there's no verb. Ditto for the two cells above. To me, it would be more consistent with e.g. the Hash and Pred entries to lowercase the two cells above this and remove the period at the end of all three.

Copy link
Member

Choose a reason for hiding this comment

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

This is also true for our "Returns:" elements, but we format those as sentences (with a leading capital letter and a trailing period).

Copy link
Contributor

Choose a reason for hiding this comment

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

It's fairly clear in that case that "Returns: Forty-two." is a stylized form of the sentence "Returns forty-two." Here, the words "[The] Return type [is]" needed to make this a sentence are much further away, and the majority of the cells don't include periods. The notion that the contents of the table cells are portions of larger sentences is a bit of a stretch.

That said, I don't find this usage particularly offensive. I'll let this one go so we can keep editorial focus on bigger issues.

@zygoloid zygoloid merged commit ec8fefa into cplusplus:master Oct 18, 2020
@jensmaurer jensmaurer deleted the c31 branch October 18, 2020 07:58
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.

[tab:container.hash.req] missing capitalization in description of node_type
3 participants