cplusplus / cplusplus/draft

[index] Using "type!POD" vs. "POD type"

Open
#1,033 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

There are index entries for "callable type", "integer type", "object type", "scalar type" and many others of this form. The index also has a list of terms under type, such as "type!POD" and "type!function". A few appear in both forms: there's "integral type" as well as "type!integral".

This makes the index hard to use, because it's not clear (to me) which form is used for any given term. I noticed this when trying to find the definition of "POD type". Would it make sense to list all of these terms as both "foo type" and "type!foo"?

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 reviewing the index entries mentioned in the issue, including “callable type,” “integral type,” “type!POD,” and “type!function,” and compare how related terms are indexed. Done should provide a consistent, navigable treatment for the affected terms, with the final scope decided before making broad changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.