cplusplus / cplusplus/draft

index entries for library declarations should point at the declaration itself, not the start of the synopsis

Open
#1,562 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

This is particularly obvious for very long synopses. We generally write index entries at the start of the synopsis block, but we should really be pointing them at the point within the synopsis where the indexed entity is declared.

We probably need a new macro for marking up a library entity in a synopsis that adds an index entry and emits the name of that entity, so we can write something like:

int @\libdecl{myfunction}@(int, int);

to emit and index the name (with another form for member functions).

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

The issue names no file, test, or entry point, so first locate the synopsis markup and existing index-entry macros in the draft sources. Compare library entities and member functions, then verify that the proposed markup emits the entity name and places its index target at the declaration rather than the synopsis start.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.