cplusplus / cplusplus/draft

Indexing of "eligible" terms

Open
#8,338 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

P3-Other
Dominant language
TeX
Stars
221
Forks
813
Avg merge
16h 4m
Merged PRs (30d)
36

Description

If we look at the index for "eligible" terms we see something like:

eligible
  for subsumption, 427
eligible for replacement, 306
eligible for trivial relocation, 305
eligible special member function, see special
   member function, eligible
eligible to be unblocked, 2168

Observe that "eligible" is a parent with one entry, "for subsumption", while all of the other terms of eligibility are top-level terms in their own right.

We should make this consistent, one way or the other. The simplest solution would be to promote "eligible for subsumption" to the top layer like the rest, but would the more principled approach to make all the other entries children of "eligible"?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the index entries shown for “eligible” and comparing their parent and top-level relationships. Review the surrounding index conventions before choosing an organization, then confirm that the eligibility terms follow one consistent hierarchy and that the generated index reflects it.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.