Skip to content

Add test coverage for multi-dash @id header resolution #2930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
singhharsh1708 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add test coverage for multi-dash @id header resolution #2930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40c4b4c
Add test coverage for multi-dash @id header resolution (issue #2732)
Apr 26, 2026
6744291
Add changelog entry for @id dashes test coverage (#2732)
Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* Fixed headers hidden by the navbar. ([#2905])
* Tightened `@ref` classification so references are matched more consistently by syntax, with header labels still taking precedence over docstrings and mistaken header/id references less likely to resolve as docstrings. ([#2678])
* Added test coverage confirming that `@ref` links to headers defined with a multi-dash `@id` (e.g. `@id my-section-title`) resolve correctly. ([#2732])

## Version [v1.17.0] - 2026-02-20

Expand Down
1 change: 1 addition & 0 deletions test/docsxref/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ end
@test contains(html, "<a href=\"index.html#Two-words\">Two words</a>")
@test contains(html, "<a href=\"index.html#Two-words\">header link</a>")
@test contains(html, "<a href=\"index.html#api-reference\">header id link</a>")
@test contains(html, "<a href=\"index.html#multi-word-section-id\">multi-dash id link</a>")
@test contains(html, "<a href=\"https://github.com/JuliaDocs/Documenter.jl/issues/12345\">#12345</a>")
@test contains(html, "<a href=\"https://github.com/JuliaDocs/Documenter.jl/issues/12345\">issue link</a>")
@test contains(html, "<a href=\"index.html#Main.DocsReferencingMain.g\"><code>DocsReferencingMain.g</code></a>")
Expand Down
3 changes: 3 additions & 0 deletions test/docsxref/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ On the *page* (unlike in the `g` docstring) can link directly to [`AbstractSelec
Implicit link to a header (single word): [API](@ref).
Explicit link to a header (single word): [header link](@ref "API").
Explicit link to a header via `@id`: [header id link](@ref api-reference).
Explicit link to a header via multi-dash `@id`: [multi-dash id link](@ref multi-word-section-id).

Implicit link to a header (multiple words): [Two words](@ref).
Explicit link to a header (multiple words): [header link](@ref "Two words").
Expand Down Expand Up @@ -52,3 +53,5 @@ Something
## [Header/docstring conflict](@id DocsReferencingMain.g)

Something else

## [Multi-word section with dashes](@id multi-word-section-id)
Loading