AdaCore / AdaCore/gnatdoc

Improvements to html:oop output

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ada
Stars
6
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I took some time to understand the meanings of the subprogram headings:

  • Declared dispatching subprograms: these are not overriding subprograms. Not sure whether others would find "'not overriding' subprograms" a more useful title.
  • Overrided dispatching subprograms:
    • typo, should be "Overridden". I wouldn’t feel bound to alter all the other occurrences!
    • as above, "'overriding' subprograms"
  • Inherited prefix-callable subprograms: not sure what benefits this brings, since in my attempt all the entries appear in "Declared prefix-callable subprograms".

Contributor guide

Open the contributing guide

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 locating the code that generates the html:oop output and the subprogram-heading text. Check how declared, overridden, and inherited prefix-callable subprograms are classified, then correct the “Overrided” wording and verify whether inherited entries are distinct from declared entries in the generated output.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
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.