[utilities] Consistently index all member typedefs in the utilites he… #6006
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This is the first of a series of patches that will cover all the standard library headers. I will await review of this first patch before producing the rest though. After filing the patch I became aware of #3911, which this patch would be seen as a small part of addressing. |
3e3edbc to
affa93c
Compare
Audited the file `utilities.tex` for indexing of member typedefs. Several
idioms were in use, and not all typedef-names were indexed. Adopted what
seemed to be the preferred approach of using the `@\libmember{}@` style of
definition within the class definition itself, so that omissions become
obvious if more typedef-names are added in the future.
Please provide feedback on whether indexing the explicit template
specialization for `<void>` types is the correct approach. It pulls
out the name that is not present for the primary template, and then
the ranges library adds some non-template classes with the same name.
e289bba to
513ccc9
Compare
|
I believe this branch has correctly been rebased, so we can lose that tag. |
jensmaurer
requested changes
Aug 24, 2025
Comment on lines
4050
to
4051
| \indexlibrarymember{iterator}{optional}% | ||
| \indexlibrarymember{const_iterator}{optional}% |
There was a problem hiding this comment.
Please review globally for now-redundant indexing like this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…ader
Audited the file
utilities.texfor indexing of member typedefs. Several idioms were in use, and not all typedef-names were indexed. Adopted what seemed to be the preferred approach of using the@\libmember{}@style of definition within the class definition itself, so that omissions become obvious if more typedef-names are added in the future.Please provide feedback on whether indexing the explicit template specialization for types is the correct approach. It pulls out the name that is not present for the primary template, and then the ranges library adds some non-template classes with the same name.
Noted that
char_typeforbasic_format_argis a private member marked as exposition only, so should really bechar-typewith the expos-id font. After checking with the original paper, will supply a separate follow-up ticket for that --- this comment is only to confirm that the omission from the index in this patch is intentional.