make-id can't change members with leading underscore

Open
#10 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
html, python
Domain
documentation, tooling

Research direction

Start at make_id and trace the final DocBook-to-HTML translation, where the issue reports the broken in-class link. Reproduce with a class member whose id starts with an underscore, then regenerate the documentation and verify the member page, index and navigation entries, and in-class link all remain correct.

Written by the indexing model from the issue text.

Description

Any changes to the "id" of a class member within make_id with a leading underscore breaks the link from within the class (though the member page is still generated, appears in index and navigation buttons).

This appears to occur in the last step where the docbook is translated to html.

Dominant language
Python
Stars
20
Forks
25
No merged PRs in 30d

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.

More from boostorg/docca

All issues in boostorg/docca

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.