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.

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

spec is inconsistant wrt use of \term{} vs. \tcode{} vs. placeholder{} for variables #320

Closed
burblebee opened this issue Jun 16, 2014 · 1 comment
Labels
big An issue causing a large set of changes, scattered across most of the text.

Comments

@burblebee
Copy link
Contributor

In e-mail with Rishcard:
Dawn: - spec is inconsistent wrt use of \term{} vs. \tcode{} vs. placeholder{} for variables (e.g. in 20.4.2.5, "Let \term{TS} denote ..."). I would like to globally change these all to use \placeholder{}, but that leads to the problem with the space mentioned above. In any case, I would like to fix.

Richard: Yes, I think we should fix this. We have another problem here: sometimes placeholders are represented in italics, and sometimes in a courier font; the choice appears to be reasonably consistent in any one local region, and seems to be whichever one is not being used in that region. If we mass-replace them, we might degrade the clarity. That said, I think this is something to pursue. Perhaps we can find a third stylistic option for them.

It's also not really clear what to do about placeholders that get used as code examples. For instance, in [conv]p3-6, 'e', 'E', 't', and 'T' are placeholders that are used in code examples, and switching them to just italics would be unhelpful. Perhaps \placeholder should give an italic courier font (as seen in 'contextually converted to bool' in paragraph 4)?

@burblebee burblebee self-assigned this Jun 16, 2014
@burblebee burblebee added the big label Jun 18, 2014
@zygoloid
Copy link
Member

Covered by #326.

@burblebee burblebee removed their assignment Nov 6, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
big An issue causing a large set of changes, scattered across most of the text.
Projects
None yet
Development

No branches or pull requests

2 participants