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

Fix index entries for 'nested/local class'. #1463

Merged
merged 1 commit into from Mar 16, 2017

Conversation

Eelis
Copy link
Contributor

@Eelis Eelis commented Feb 14, 2017

  • Changes the peculiar redirection entries "class nested" and "class local" to the more conventional "class, nested" and "class, local".
  • Adds main index entries for "local class" and "nested class" (fixing some abuse of \grammarterm in the process)

diffs.pdf


\pnum
A class can be declared within another class. A class declared within
another is called a \grammarterm{nested} class. The name of a nested class
another is called a \defnx{nested}{nested class} class. The name of a nested class
is local to its enclosing class.
Copy link
Member

Choose a reason for hiding this comment

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

The defined phrase is actually "nested class", so I'd like to see both words in italics. (Same for "local class".)

@@ -1387,12 +1387,11 @@

\rSec2[class.nest]{Nested class declarations}%
\indextext{definition!nested class}%
\indextext{class local|see{local class}}%
\indextext{class nested|see{nested class}}
\indextext{class!nested|see{nested class}}

Copy link
Member

Choose a reason for hiding this comment

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

In general, it seems to me we gravitate towards "class!nested" as the main index entry (where all the page numbers go) and have "nested class" as the "see ..." entry.

Copy link
Contributor Author

@Eelis Eelis Feb 15, 2017

Choose a reason for hiding this comment

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

Both "local class" and "nested class" have a bunch of subentries:

subentries

Should these be moved under "class, local" and "class, nested", respectively, as well, or stay where they are?

I guess an argument for moving them is that otherwise, if there is only a "local class"-->"class, local" redirect, then someone might find "class, local" in the index and never receive a clue that there are also relevant index entries under "local class" to look at.

@zygoloid zygoloid added this to the C++17 milestone Mar 3, 2017
@zygoloid zygoloid merged commit b7d3b5e into cplusplus:master Mar 16, 2017
@Eelis Eelis deleted the classindex branch March 16, 2017 02:27
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