racket / racket/scribble

Nested `deftech` fails to generate a link in Search Manual

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

Nobody has claimed this yet.

Dominant language
Racket
Stars
250
Forks
102
Avg merge
11d 11h
Merged PRs (30d)
1

Description

What version of Racket are you using?
8.12 [cs]

What program did you run?
Here is a snippet of my .scrbl file that seems to cause the issue:

@subsection{Commutative Diagram}

Informally, a @deftech{diagram} comprises various @tech{objects} connected by
various @tech{morphisms}. When the @tech{morphisms} with the same @tech{domain}
and @tech{codomain} are the same one, the @tech{diagram} is a
@deftech{@deftech{commutative} diagram}.

@tech{Commutative diagrams} serve as a powerful language for expressing equations.

@subsubsection{Commutative Triangle}

A @deftech{commutative triangle} is a @tech{commutative diagram} that has the shape
of a triangle.

What should have happened?
The nested use of deftech should generate correct links in both the .html file and the Search Manual for all defined technical terms. Specifically, the term "commutative diagram" should be properly linked in the Search Manual like "commutative triangle".

If you got an error message, please include it here.
No error message was displayed, but the expected link creation in the Search Manual was not observed for the nested deftech tags.

Please include any other relevant details

In .html:
html

In Search Manual:
search-manual

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

Start with the nested deftech example in the .scrbl snippet and reproduce the generated .html and Search Manual output. Compare the links for "commutative diagram" and "commutative triangle"; done means nested definitions generate correct links in both outputs.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.