Skip to content

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

Closed

Description

@jensmaurer

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$.

Activity

  1. added
    decision-requiredA decision of the editorial group (or the Project Editor) is required.
    on Aug 6, 2019
  2. changed the title [-][std] Use of \placeholder for atomics variables[/-] [+][std] Use of \placeholder for atomic operations meta-variables[/+] on Aug 6, 2019
  3. jensmaurer commented on Sep 9, 2019

    @jensmaurer
    MemberAuthor

    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.

  4. removed
    decision-requiredA decision of the editorial group (or the Project Editor) is required.
    on Sep 10, 2019
  5. jensmaurer commented on Sep 10, 2019

    @jensmaurer
    MemberAuthor

    Rules documented in wiki.

  6. jensmaurer commented on Sep 10, 2019

    @jensmaurer
    MemberAuthor

    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.)

  7. added
    decision-requiredA decision of the editorial group (or the Project Editor) is required.
    on Sep 10, 2019
  8. jensmaurer commented on Oct 2, 2019

    @jensmaurer
    MemberAuthor

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

  9. jensmaurer commented on Nov 4, 2019

    @jensmaurer
    MemberAuthor

    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.

  10. removed
    decision-requiredA decision of the editorial group (or the Project Editor) is required.
    on Nov 4, 2019
  11. self-assigned this
    on Dec 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions