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

[basic.link] consistent indexing of 'translation unit' #931

Merged

Conversation

AlisdairM
Copy link
Contributor

Ensure all definitions of 'translation unit' sort together
in the index, with a common spelling of the white-space.

@@ -2233,8 +2233,8 @@

\pnum
\indextext{program}%
A \defn{program} consists of one or more \defn{translation
units} (Clause~\ref{lex}) linked together. A translation unit consists
A \defn{program} consists of one or more \defn{translation units}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need a separate entry for "translation units" (plural)? Can we not index this also under "translation unit"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about changing this, but the term is a \defn today, and I don't think we have precedent for moving the 's' outside the \defn. I certainly did not want to rewrite core wording so that this term might be re-rendered as singular, so opted for the lesser among evils, leaving the term as defined.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The usual solution would be \defnx{plural}{singular}. We've done that or similar things elsewhere. I think that'd be appropriate here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Examples:

  • \defnx{encoded character types}{encoded character type}
  • \defnx{makes progress}{make progress} :-)

@tkoeppe
Copy link
Contributor

tkoeppe commented Sep 27, 2016

@AlisdairM: Ping

@AlisdairM
Copy link
Contributor Author

Sorry, got distracted with a few other issues, will try to push an updated patch tomorrow. Thanks for following up :)

@AlisdairM AlisdairM force-pushed the consistent_indexing_of_translation_unit branch from 17539ee to 48164fc Compare November 12, 2016 07:27
@jensmaurer
Copy link
Member

Alisdair, we're still waiting for the updated patch.

Ensure all definitions of 'translation unit' sort together
in the index, with a common spelling of the white-space.
Rebase onto master, and use the \defnx macro to define the plural form
of a term in the main text, but enter only the singular form in the index.
@AlisdairM AlisdairM force-pushed the consistent_indexing_of_translation_unit branch from 48164fc to 7e6a992 Compare November 12, 2016 16:09
@AlisdairM
Copy link
Contributor Author

Updated patch available, using the \defnx macro as suggested.

@tkoeppe tkoeppe merged commit 337fd04 into cplusplus:master Nov 12, 2016
@AlisdairM AlisdairM deleted the consistent_indexing_of_translation_unit branch November 12, 2016 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants