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

unify capitalization of node_handle and INSERT_RETURN_TYPE #2014

Closed
zygoloid opened this issue Apr 2, 2018 · 5 comments
Closed

unify capitalization of node_handle and INSERT_RETURN_TYPE #2014

zygoloid opened this issue Apr 2, 2018 · 5 comments
Assignees

Comments

@zygoloid
Copy link
Member

zygoloid commented Apr 2, 2018

We render the placeholder type INSERT_RETURN_TYPE in uppercase italics but render the placeholder type node_handle in lowercase italics. Likewise, we render the exposition-only name signal-handler in lowercase italics but INVOKE in uppercase italics.

We should establish a convention here, and if there is a reason for the difference in capitalization, it should be documented somewhere.

@jensmaurer
Copy link
Member

Why is node_handle a large-scale placeholder anyway? All other type requirements are phrased as tables (ok, also sub-optimal) instead of showing a pseudo class synopsis.

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Apr 3, 2018
@tkoeppe
Copy link
Contributor

tkoeppe commented Apr 3, 2018

In my understanding, "node_handle" is an exposition-only class, but it's still an actual class, hence class name capitalization. By contrast, the capital-italics INSERT_RETURN_TYPE is a placeholder for something that we fill in later (like EXPLICIT).

So it's exposition-only vs placeholders. I think that's not too bad.

@jensmaurer
Copy link
Member

jensmaurer commented Jun 7, 2018

Editorial meeting consensus: Use lowercase italics teletype with hyphens, not underscores, for exposition-only types (cf. signal-handler) to clarify they are not standard-blessed names. (This is unclear for node_handle.) Apply this convention to all exposition-only types where a C++-level definition is shown in the standard such as INSERT_RETURN_TYPE or call_wrapper.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Jun 7, 2018
@zygoloid
Copy link
Member Author

zygoloid commented Jun 7, 2018

Retain all-uppercase italic teletype for INVOKE and GENERALIZED_NONCOMMUTATIVE_SUM, which are sort-of macros at the standard level, and don't directly represent source constructs.

@jwakely
Copy link
Member

jwakely commented Jun 7, 2018

node_handle is definitely not a standard-blessed name, so using node-handle for that makes sense.

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

No branches or pull requests

4 participants