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.

Sign up for GitHub

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

Jump to bottom

[diff] Inconsistent LaTeX source code style #3129

Closed
burblebee opened this issue Aug 5, 2019 · 5 comments · Fixed by #3221
Closed

[diff] Inconsistent LaTeX source code style #3129

burblebee opened this issue Aug 5, 2019 · 5 comments · Fixed by #3221
Assignees
@jensmaurer

Comments

@burblebee
Copy link
Contributor

burblebee commented Aug 5, 2019 •
edited

We're inconsistent in the Latex coding style used for clauses in [diff.iso]. Some place the text on the same line as the <clause_macro>, others don't. Our guidelines don't specify how they should be formatted. I'd like to see us format them similarly to \items, where a single line is used if the text is short, and 2-space indentation is used for clauses which span multiple lines.

Can we come up with some guidelines, document them, and do a global whitespace change to fix the old formatting style so that we can follow the guidelines when applying edits?
@burblebee burblebee added the decision-required A decision of the editorial group (or the Project Editor) is required. label Aug 5, 2019
@jensmaurer
Copy link
Member

[diff.iso] is just "C++ and ISO C"; did you mean that, or did you mean all of [diff]?

@jensmaurer
Copy link
Member

Editorial teleconference: We should absolutely document the policy.
Also consider ease of finding the source of a change. Probably made easier by current github "blame" view. Current approach mixes whitespace changes with semantic changes, which is worse than having a separate and early whitespace change.

@jensmaurer
Copy link
Member

Editorial teleconference: \pnum should be on a line by itself.

@jensmaurer
Copy link
Member

jensmaurer commented Sep 9, 2019 •
edited

Editorial teleconference: Happier about global rules if/when we enforce them. Otherwise, we will backslide.

@jensmaurer
Copy link
Member

Editorial teleconference: Newlines around "\rationale" etc. macros in diff.iso. Drop empty lines around "codeblock". Thus, no blank lines except to separate differences.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Sep 9, 2019
This was referenced Sep 10, 2019
Merged
Merged
@jensmaurer jensmaurer changed the title [diff.iso] Inconsistent Latex coding style used in clauses [diff] Inconsistent Latex coding style used in clauses Sep 11, 2019
@jensmaurer jensmaurer changed the title [diff] Inconsistent Latex coding style used in clauses [diff] Inconsistent LaTeX source code style Sep 11, 2019
@jensmaurer jensmaurer self-assigned this Sep 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jensmaurer jensmaurer

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[diff] Move markers to lines of their own. jensmaurer/draft
2 participants
@burblebee @jensmaurer