Library index is missing many enumerators
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
May be related to #2972 but I think that is only about the main index.
The library contains a variety of enumerations, or bitfield/mask types that provide names like an enumeration. However, many of the enumerator names, while essentially reserved for use in such library contexts (users cannot name macros the same, etc.), are not listed in the library index.
My search is far from exhaustive, but I started from Annex D code_cvt mode enumerators, and then noticed most/all of the bitfields and bit masks in ios_base are missing, and then filed this ticket.
If we do add these names, how should we describe/index them? As members of their enumerator/surrounding class? Under their own name with an ref back to their host?
Given late filing and potential scale, this issue probably should not be considered before C++23 work starts.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the library index entries for Annex D code_cvt enumerators and the bitfields and masks in ios_base, then compare the related scope in issue #2972. Determine the indexing convention for enumerators and host members; done means the missing library names are identified and consistently indexed under an agreed structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100