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

"possibly const" vs "possibly \tcode{const}" vs "possibly \keyword{const}" #117

Closed
sdutoit opened this issue May 12, 2013 · 14 comments · Fixed by #6025
Closed

"possibly const" vs "possibly \tcode{const}" vs "possibly \keyword{const}" #117

sdutoit opened this issue May 12, 2013 · 14 comments · Fixed by #6025
Assignees

Comments

@sdutoit
Copy link
Contributor

sdutoit commented May 12, 2013

"possibly const" appears five times in the current draft. "possibly \tcode{const}" appears ten times. Clean this up, make a rule for it.

Update added by @burblebee on 11/15/22:
We've since added several more of the above variations as well as the addition of "possibly \keyword{const}".

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 13, 2016
@jensmaurer
Copy link
Member

Editorial meeting consensus: Similar to inline / public. Thus, we should generally not use "possibly \tcode{const}".

@zygoloid
Copy link
Member

zygoloid commented Mar 2, 2017

See also issue #106.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Mar 2, 2017
@jensmaurer
Copy link
Member

jensmaurer commented Mar 28, 2017

Postponing until #1497 is applied to avoid editing conflicts.

@burblebee burblebee changed the title "possibly const" vs "possibly \tcode{const}" "possibly const" vs "possibly \tcode{const}" vs "(possibly \keyword{const})" Nov 15, 2022
@burblebee burblebee changed the title "possibly const" vs "possibly \tcode{const}" vs "(possibly \keyword{const})" "possibly const" vs "possibly \tcode{const}" vs "possibly \keyword{const}" Nov 15, 2022
@burblebee
Copy link
Contributor

Editorial meeting consensus: Similar to inline / public. Thus, we should generally not use "possibly \tcode{const}".

To clarify, all occurrences should become possibly const, correct?

@JohelEGP
Copy link
Contributor

See #4405 (comment) with regards to \keyword. @tkoeppe, can \keyword be rationalized on the wiki?

@burblebee
Copy link
Contributor

burblebee commented Nov 15, 2022

I don't think we should use \keyword in this case, since this is basically equivalent to "possibly cv-qualified" (and other variations of "cv"), and we don't include references to those in the index under const. So if we want to recognize "const" here as a keyword (e.g. so we could make them a different color sometime in the future as mentioned in #4405), maybe we need something like a \keywordni (ni for no index)? What about uses of "non-const"?

Adding the "decision required" label back - I'm happy to take this one on if I know what we want to do here.

@burblebee burblebee added the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 15, 2022
@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 16, 2022

I think the original decision to say "possibly const" (without markup) is uncontested; shall we just execute that?

@sdutoit
Copy link
Contributor Author

sdutoit commented Nov 16, 2022

I think the original decision to say "possibly const" (without markup) is uncontested; shall we just execute that?

Yes please, after these 9+ years! :)

@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 16, 2022

@sdutoit Why did you leave? :-)

@tkoeppe
Copy link
Contributor

tkoeppe commented Nov 16, 2022

@burblebee What do you think needs a decision here? Don't we already have several decisions above?

@burblebee
Copy link
Contributor

I think the original decision to say "possibly const" (without markup) is uncontested; shall we just execute that?

Sure! Sorry this resolution wasn't clear to me, but
"we should generally not use possibly \tcode{const}."
doesn't say what we should do, so thank you for the clarification! There is now the added complexity with \keyword{const}, but I feel the "just say possibly const" resolution works there to.

@burblebee burblebee removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 17, 2022
@burblebee burblebee self-assigned this Nov 17, 2022
@jwakely
Copy link
Member

jwakely commented Dec 9, 2022

Arguably we should just say "type X or const X" instead of "type (possibly const) X".

Not using keyword markup for "possibly const" does look a bit odd when we have:

an lvalue of type (possibly const) X or an rvalue of type const X,

Based on the decision above, one "const" is is code font and one isn't.

@zygoloid
Copy link
Member

I think the original decision to say "possibly const" (without markup) is uncontested; shall we just execute that?

Yes please, after these 9+ years! :)

I also favor this direction. Hm, I wonder if we can get Pete Becker's signoff too? :)

@tkoeppe
Copy link
Contributor

tkoeppe commented Dec 16, 2022

@jwakely That one case you pointed out could indeed be rewritten a little to avoid this awkwardness.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants