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

[std] Use of \placeholder for atomic operations meta-variables #3139

Closed
jensmaurer opened this issue Aug 6, 2019 · 5 comments · Fixed by #3553
Closed

[std] Use of \placeholder for atomic operations meta-variables #3139

jensmaurer opened this issue Aug 6, 2019 · 5 comments · Fixed by #3553
Assignees
@jensmaurer

Comments

@jensmaurer
Copy link
Member

jensmaurer commented Aug 6, 2019 •
edited

Our current (undocumented) guidance is

  • \tcode{foo} is used for stuff that may occur in source code, given a suitable environment.
  • \placeholder is used for code meta-variables, e.g. exposition-only types and concepts
  • Other meta-variables and indexing use math mode: $\tcode{T}_i$

First, we should document this policy. Second, we should also apply it to the atomics meta-variables when constructing all sorts of partial orders throughout [basic] and [atomics]. That is, these should change from \placeholder to $math mode$.
@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Aug 6, 2019
@jensmaurer jensmaurer changed the title [std] Use of \placeholder for atomics variables [std] Use of \placeholder for atomic operations meta-variables Aug 6, 2019
@jensmaurer
Copy link
Member Author

Editorial teleconference: \placeholder is a variable to be replaced by source code. Add examples. Agreed with the changes in [basic] and [atomics] for "atomic operation A" and "memory location M" etc.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Sep 10, 2019
@jensmaurer
Copy link
Member Author

jensmaurer commented Sep 10, 2019 •
edited

Rules documented in wiki.

@jensmaurer
Copy link
Member Author

jensmaurer commented Sep 10, 2019 •
edited

Uh, using $M$ for the memory model placeholders has an unfortunate side-effect: We lose the italics correction:
Before:
comma-before
After:
comma-after

Not good. (Branch c24.)

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Sep 10, 2019
@jensmaurer
Copy link
Member Author

Editorial teleconference: Wait for more LaTeX expertise to be present.

@jensmaurer
Copy link
Member Author

Editorial meeting: This change is actually intended; math-mode should stand out and not run into the surrounding text. We're fine with the extra space.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 4, 2019
This was referenced Nov 19, 2019
Merged
Closed
@jensmaurer jensmaurer mentioned this issue Dec 15, 2019
Merged
@jensmaurer jensmaurer self-assigned this Dec 15, 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.

[basic.atomics] Use math mode for memory model placeholders. jensmaurer/draft
1 participant
@jensmaurer