Use \term and \defnx more correctly and consistently #980

Eelis · 2016-11-11T14:15:09Z

No visual difference in the PDF.

Eelis · 2016-11-11T14:39:38Z

Please hold, spotted a few more

Eelis · 2016-11-11T16:54:06Z

Added a commit that also fixes abuse of \term for things that are not terms at all.

Only visual difference now is erasure of some inappropriate trailing whitespace resulting from the fact that in addition to making text italic, \term also includes a trailing \xspace.

zygoloid · 2016-11-12T10:19:03Z

Looks good other than that we would prefer the more semantic \placeholder be used rather than \textit in the incorrect uses of \term for placeholders.

Eelis · 2016-11-12T10:47:12Z

Ah, thanks for the review, will fix (and rebase).

Eelis · 2016-11-12T12:53:23Z

Fixed and rebased. (Still no visual difference apart from the trailing whitespace.)

Eelis · 2016-11-12T12:55:24Z

Bleh, missed a few, so not completely fixed yet

Eelis · 2016-11-12T21:34:10Z

Added fixes for a whole bunch more occurrences

tkoeppe · 2016-11-17T16:09:24Z

source/atomics.tex

 always be extended to an order that does include lock and unlock operations, since the
 ordering between those is already included in the ``happens before'' ordering. \end{note}

 \pnum
-For an atomic operation \textit{B} that reads the value of an atomic object \textit{M},


I'm sorry to be a complete pain, but in view of Issue #1060, could we please hold off on ripping out \textit everywhere for now? I'd prefer if one commit could focus on one change, namely getting rid of \term. If that happens to introduce a few \placeholders, that's fine, but let's not introduce them for unrelated reasons.

Ah no worries, I'm glad to hear there's coherent plans being formed for the use of all these things going forward. :) I'll split out the \term stuff tonight, cheers!

jensmaurer · 2016-11-17T17:56:46Z

Sorry, hadn't noticed this before. #1061 and #1062 as well as #1060 might conflict.

Eelis · 2016-11-17T21:32:55Z

All right, I've split it up more, and now it only uses \placeholder to replace bad uses of \term, leaving other \textit occurrences alone (apart from those that should be \terms).

tkoeppe · 2016-11-17T21:33:58Z

@jensmaurer: As the standing expert on all things \term, could you please review this PR?

jensmaurer · 2016-11-17T21:47:00Z

source/lex.tex

-the \term{literal} \term{L} is treated as a call of the form
+Otherwise, \placeholder{S} shall contain a raw literal operator or a literal operator
+template~(\ref{over.literal}) but not both. If \placeholder{S} contains a raw literal operator,
+the \placeholder{literal} \placeholder{L} is treated as a call of the form



\term{literal} should be \grammarterm{literal}, not \placeholder

jensmaurer · 2016-11-17T21:49:50Z

source/lib-intro.tex

+static const @\placeholder{enumerated C0}@ (@\placeholder{V0}@);
+static const @\placeholder{enumerated C1}@ (@\placeholder{V1}@);
+static const @\placeholder{enumerated C2}@ (@\placeholder{V2}@);
+static const @\placeholder{enumerated C3}@ (@\placeholder{V3}@);
  .....


Those are two distinct placeholders. Please try separating them (i.e. have two \placeholder's next to each other). Does that impair the spacing?

jensmaurer · 2016-11-17T21:50:26Z

source/lib-intro.tex

+constexpr @\placeholder{bitmask C0}@(@\placeholder{V0}{}@);
+constexpr @\placeholder{bitmask C1}@(@\placeholder{V1}{}@);
+constexpr @\placeholder{bitmask C2}@(@\placeholder{V2}{}@);
+constexpr @\placeholder{bitmask C3}@(@\placeholder{V3}{}@);
  .....


Same here: two \placeholders, once for each meta-variable.

jensmaurer · 2016-11-17T21:54:29Z

source/regex.tex

@@ -3916,7 +3916,7 @@
 sequence \end{note}

 \pnum
-The \textit{current match} is \tcode{(*position).prefix()} if \tcode{subs[N] == -1}, or
+The \term{current match} is \tcode{(*position).prefix()} if \tcode{subs[N] == -1}, or
 \tcode{(*position)[subs[N]]} for any other value of \tcode{subs[N]}.

 \rSec3[re.tokiter.cnstr]{\tcode{regex_token_iterator} constructors}


This patch adds \term, which this issue tries to eradicate (admittedly morphed from even worse \textit). Please drop this patch from here for now; I expect those \textit to mostly become \defn or \defnx.

Ah ok, I didn't know there was a plan to eradicate \term. (Not sure what "this issue" refers to.)

Well, if we replace all of \term with more semantic macros such as \placeholder or \defn/x or ..., then nothing remains, right?

jensmaurer · 2016-11-17T21:56:15Z

source/classes.tex

 class, and has no non-static data members of type non-POD struct, non-POD
-union (or array of such types). A \term{POD class} is a
+union (or array of such types). A \defn{POD class} is a
 class that is either a POD struct or a POD union.

 \begin{example}


Do we have any rules when to use "POD~struct" vs. "POD struct" in the index? We seem to prefer the variant with the tilde = non-breaking space. If true, the stuff above needs to become \defnx.

I'll change it to use tilde, so that we're covered if one day we want to render the index so narrowly that an entry consisting of 2 words side by side would get broken.

If being prepared for that is an actual goal, though, there are hundreds more occurrences that need to be replaced.

jensmaurer · 2016-11-17T21:57:45Z

source/lex.tex

 integer literal (base ten) begins with a digit other than \tcode{0} and
 consists of a sequence of decimal digits.
-A \term{hexadecimal} integer literal (base sixteen) begins with
+A \defnx{hexadecimal}{literal!hexadecimal} integer literal (base sixteen) begins with
 \tcode{0x} or \tcode{0X} and consists of a sequence of hexadecimal


Please put all of "XXX integer literal" into the first argument of \defnx; we're not actually defining the term "decimal" here, but the phrase "decimal integer literal".

jensmaurer · 2016-11-17T22:01:28Z

source/utilities.tex

@@ -12224,30 +12224,24 @@
 The following definitions apply to this Clause:

 \pnum
-\indexdefn{call signature}%
-A \term{call signature} is the name of a return type followed by a
+A \defn{call signature} is the name of a return type followed by a
 parenthesized comma-separated list of zero or more argument types.



For this (and those that follow), the index entries should probably use tilde instead of space.

jensmaurer · 2016-11-17T22:03:03Z

Review complete; see comments above. Going to bed now.

Eelis · 2016-11-17T22:55:50Z

Hm, this pull request has really lost focus. I originally just wanted to use \defn* for \terms that already had index entries, a change which I could make without affecting those index entries or the formatting of the text, but I don't feel qualified to make the kind of changes to the index entries themselves (by changing their use of tildes) or to the formatting of the text (by changing which parts of the text are italicized) that Jens is requesting, so probably better to just go with his patches. :)

Eelis force-pushed the defterm branch 2 times, most recently from 7bc1bd1 to d05fde0 Compare November 11, 2016 16:53

Eelis force-pushed the defterm branch from d05fde0 to 2a108f5 Compare November 12, 2016 12:52

Eelis force-pushed the defterm branch from 2a108f5 to f54a196 Compare November 12, 2016 21:29

Eelis changed the title ~~Replace \indextext + \term pairs with \defnx (or \defn).~~ Use \defnx, \placeholder, \term, and \cv where appropriate. Nov 12, 2016

tkoeppe mentioned this pull request Nov 17, 2016

All definitions should be indexed #329

Open

tkoeppe force-pushed the master branch from d2a10b4 to c1f9b30 Compare November 17, 2016 14:36

tkoeppe mentioned this pull request Nov 17, 2016

[basic] Replace \term with \defnx as appropriate #1061

Merged

Eelis force-pushed the defterm branch from f54a196 to bceee0b Compare November 17, 2016 16:02

tkoeppe reviewed Nov 17, 2016

View reviewed changes

Eelis added 4 commits November 17, 2016 22:17

Replace \term with \placeholder where appropriate.

c5b8c2a

Replace \textit with \term where appropriate.

73ec55d

Replace \indextext + \term pairs with \defnx (or \defn).

44480b0

Remove superfluous whitespace.

bac75d2

Eelis force-pushed the defterm branch from bceee0b to bac75d2 Compare November 17, 2016 21:29

Eelis changed the title ~~Use \defnx, \placeholder, \term, and \cv where appropriate.~~ Use \term more correctly and consistently Nov 17, 2016

Eelis changed the title ~~Use \term more correctly and consistently~~ Use \term/\defnx more correctly and consistently Nov 17, 2016

Eelis changed the title ~~Use \term/\defnx more correctly and consistently~~ Use \term and \defnx more correctly and consistently Nov 17, 2016

jensmaurer reviewed Nov 17, 2016

View reviewed changes

Eelis closed this Nov 17, 2016

Eelis deleted the defterm branch November 17, 2016 22:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use \term and \defnx more correctly and consistently #980

Use \term and \defnx more correctly and consistently #980

Eelis commented Nov 11, 2016

Eelis commented Nov 11, 2016

Eelis commented Nov 11, 2016

zygoloid commented Nov 12, 2016

Eelis commented Nov 12, 2016

Eelis commented Nov 12, 2016

Eelis commented Nov 12, 2016

Eelis commented Nov 12, 2016

tkoeppe Nov 17, 2016

Eelis Nov 17, 2016

jensmaurer commented Nov 17, 2016

Eelis commented Nov 17, 2016 •

edited

tkoeppe commented Nov 17, 2016

jensmaurer Nov 17, 2016

jensmaurer Nov 17, 2016

jensmaurer Nov 17, 2016

jensmaurer Nov 17, 2016

Eelis Nov 17, 2016 •

edited

jensmaurer Nov 17, 2016

jensmaurer Nov 17, 2016

Eelis Nov 17, 2016

Eelis Nov 17, 2016 •

edited

jensmaurer Nov 17, 2016

jensmaurer Nov 17, 2016

jensmaurer commented Nov 17, 2016

Eelis commented Nov 17, 2016

Use \term and \defnx more correctly and consistently #980

Use \term and \defnx more correctly and consistently #980

Conversation

Eelis commented Nov 11, 2016

Eelis commented Nov 11, 2016

Eelis commented Nov 11, 2016

zygoloid commented Nov 12, 2016

Eelis commented Nov 12, 2016

Eelis commented Nov 12, 2016

Eelis commented Nov 12, 2016

Eelis commented Nov 12, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jensmaurer commented Nov 17, 2016

Eelis commented Nov 17, 2016 • edited

tkoeppe commented Nov 17, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eelis Nov 17, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eelis Nov 17, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jensmaurer commented Nov 17, 2016

Eelis commented Nov 17, 2016

Eelis commented Nov 17, 2016 •

edited

Eelis Nov 17, 2016 •

edited

Eelis Nov 17, 2016 •

edited