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
Comments
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. |
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 So it's exposition-only vs placeholders. I think that's not too bad. |
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 |
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. |
|
We render the placeholder type
INSERT_RETURN_TYPE
in uppercase italics but render the placeholder typenode_handle
in lowercase italics. Likewise, we render the exposition-only namesignal-handler
in lowercase italics butINVOKE
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.
The text was updated successfully, but these errors were encountered: