Heading levels differ for classes versus functions

Open
#7 0 comments 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
python
Domain
documentation

Research direction

Compare the generated class page and method page linked in the issue, then inspect how their symbols are nested in the XML. Confirm that heading levels are derived consistently from that nesting, and verify that the workaround using an explicit [h3 Synopsis] is no longer needed.

Written by the indexing model from the issue text.

Description

For example:
class
method

A workaround is to manually specify an explicit heading level, e.g. [h3 Synopsis]

This most likely is caused when symbols are at different section nesting depth in the xml.

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.