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
Formatting in "Effects: Equivalent to" is confusing #694
Comments
Let's have three different forms:
No colon, period following expression.
Colon, no period, full statement including semicolon.
Colon, no period, full statement including semicolon(s), in code block. If an expression doesn't fit in the first form, we should convert it to a statement and use the third form. |
That's the plan, but if the text is already: There is also a problem where we have: |
Whatever style gets decided on, please make sure it's documented at https://github.com/cplusplus/draft/wiki/Specification-Style-Guidelines and inform LWG, otherwise nobody will follow the convention. |
Fixes include: * insert ':' before codeblocks (cplusplus#694) * fix punctuation and capitalization * turn long \tcode'd code into codeblocks * fix inconsistencies * other minor edits in \effects clauses noticed while scanning thru source Fixes cplusplus#694.
It's unclear when an Effects: clause is specifying an expression verses a code block. As a result, the trailing ; on intended code blocks ends up looking like a typo. (I've inadvertently 'fixed' a few of these apparent 'typos' myself).
To tell when the Effects is specifying a code block with statement(s) vs. an expression, I propose we follow the convention used in [thread.condition.condvar] (and elsewhere) which uses a : before code blocks. Examples:
OK?
-- in related e-mail correspondence --
from Richard:
from STL:
The text was updated successfully, but these errors were encountered: