Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 16, 2017
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/classes.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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.

\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".)

\indextext{nested class!scope of}%
The nested class is in the scope of its enclosing class.
Expand Down Expand Up @@ -1757,10 +1756,11 @@
\rSec1[class.local]{Local class declarations}
\indextext{declaration!local class}%
\indextext{definition!local class}%
\indextext{class!local|see{local class}}%

\pnum
A class can be declared within a function definition; such a class is
called a \grammarterm{local} class. The name of a local class is local to
called a \defnx{local}{local class} class. The name of a local class is local to
its enclosing scope.
\indextext{local class!scope of}%
The local class is in the scope of the enclosing scope, and has the same
Expand Down