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

Create index for macro names #7297

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JohelEGP
Copy link
Contributor

@JohelEGP JohelEGP commented Oct 8, 2024

See #6005.

@AlisdairM
Copy link
Contributor

If this lands, I will do the work to populate the index over the pending holiday season.
I might send Joel a PR for his branch, if we are in favor of this work, so the index can land initially populated.

source/back.tex Outdated Show resolved Hide resolved
source/back.tex Outdated
\clearpage
\renewcommand{\preindexhook}{The bold page number for each entry is the page
where the macro is defined.
Other page numbers refer to pages where the macro is mentioned in the general text.}
Copy link
Contributor

Choose a reason for hiding this comment

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

The text describing the index is not accurate, as the LaTeX macros do not support annotating a primary definition. It is not clear that the primary definition language will be useful for C++ macros either.

I failed to come up with a better introductory paragraph myself though, as all of the other indexes start with specific text that does not apply here either.

Copy link
Member

Choose a reason for hiding this comment

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

The text describing the index is not accurate, as the LaTeX macros do not support annotating a primary definition.

Well, for the library concepts index, we do have a bold page number for the primary definition. (I haven't looked at the actual LaTeX macros proposed here.)

Copy link
Contributor Author

@JohelEGP JohelEGP Oct 19, 2024

Choose a reason for hiding this comment

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

Added \defstdmacro for where the macro semantics is defined
(might be in prose, not necessarily a #define).

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.

3 participants