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

[util.smartptr] Cleanse of italics infestation. #1161

Merged
merged 1 commit into from Dec 2, 2016

Conversation

jensmaurer
Copy link
Member

Technical terms should not be in italics everywhere they are referenced.
Common terms such as 'owns' or 'empty' that are used as technical terms
in this subsection only are not italicized or entered into the index.

Fixes #533.

@tkoeppe
Copy link
Contributor

tkoeppe commented Dec 1, 2016

Do you not even want to retain the italics in the definition of the term? I kind of feel that it would be a bit more readable to have that meta-syntactic distinction.

@jensmaurer
Copy link
Member Author

That's what I understood Richard's position to be.

In any case, we talk about "empty" in [container.requirements.general] all over the place, but we never italicize the term.

Also, we're not defining "empty", we're (at best) defining "empty shared_ptr" as the term of art here. And you don't want to look at italics \tcode text, ever.

@tkoeppe
Copy link
Contributor

tkoeppe commented Dec 2, 2016

Well, that may be so, but all the same I am now left to wonder:

A shared_ptr object is empty if it does not own a pointer.

Is this a normative requirement on shared_ptr's behaviour when it doesn't own a pointer? Oh, no, it's defining the meaning of "empty". Hm. I mean, I don't dispute that we use this style, I'm just saying that it's an ambiguity that requires additional attention.

@zygoloid
Copy link
Member

zygoloid commented Dec 2, 2016 via email

@tkoeppe
Copy link
Contributor

tkoeppe commented Dec 2, 2016

I like that!

Technical terms should not be in italics everywhere they are referenced.
Common terms such as 'owns' or 'empty' that are used as technical terms
in this subsection only are not italicized or entered into the index.

Fixes cplusplus#533.
@jensmaurer
Copy link
Member Author

Updated as desired.

@tkoeppe tkoeppe merged commit afef023 into cplusplus:master Dec 2, 2016
@W-E-Brown
Copy link
Contributor

This makes me sad. I rather like italics for terms being defined. I don't mind the "is said to be" phrasing, but for me it's not a substitute. Unless you want to have a separate "Definitions" subclause, of course. (I don't, but could live with it.)

@jensmaurer jensmaurer deleted the b7 branch December 3, 2016 06:56
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

4 participants