AdaCore / AdaCore/learn

Syntax Highlighting on Generics Page is Broken By Keyword

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

Nobody has claimed this yet.

website infrastructure
Dominant language
Ada
Stars
117
Forks
49
Avg merge
44m
Merged PRs (30d)
8

Description

Starting in "Example: Swap" (in the "Generics" chapter of "Intro to Ada"), there is reference, in text, to a procedure titled Generic_Swap. This procedure is not highlighted with orange text (as is typical of code references). It is highlighted with green AND orange text. The Generic_ portion of the procedure is green, the Swap portion is orange. Since green text is typically used for keywords, it seems like the interpreter thinks Generic_ should be highlighted as a keyword.

REF: Generics file

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

The affected page is content/courses/intro-to-ada/chapters/generics.rst; start at the “Example: Swap” reference to Generic_Swap and trace how its syntax highlighting is applied. Done means the full procedure name is rendered consistently as a code reference, without green keyword styling on Generic_.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.