Fix auto links to subheader when TOC is present #20279
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It was observed (in nim-lang#20112) that links to 2nd- (and subsequent) -level headings fail if TOC is present, e.g.: ```nim .. contents:: Type relations ============== Convertible relation -------------------- Ref. `Convertible relation`_ ``` The problem here is that links are resolved in `rst.nim` but later `rstgen.nim` fixes ("fixes") anchors to make them unique so that TOC always works (if e.g. there was another sub-section like "Convertible relation"). The solution implemented in this PR is to move that fix-up of anchors into `rst.nim`, so that link resolution could know final anchors. The bug seems to be added in nim-lang#2332 in 2015, that is it is present in Nim 1.0.
|
Thanks for your hard work on this PR! Hint: mm: orc; threads: on; opt: speed; options: -d:release |
a-mr
added a commit
to a-mr/Nim
that referenced
this pull request
Sep 7, 2022
Also the warning is improved a bit. Local links (targeting inside its document) which had had a full anchor were turned into concise form. The very fact that they existed may be due to the bug in reference to subsections fixed nim-lang#20279, now they are working well (both in RST syntax and new Pandoc Markdown syntax implemented in nim-lang#20304)
Varriount
pushed a commit
that referenced
this pull request
Sep 9, 2022
Markdown link migration part 1 Also the warning is improved a bit. Local links (targeting inside its document) which had had a full anchor were turned into concise form. The very fact that they existed may be due to the bug in reference to subsections fixed #20279, now they are working well (both in RST syntax and new Pandoc Markdown syntax implemented in #20304)
capocasa
pushed a commit
to capocasa/Nim
that referenced
this pull request
Mar 31, 2023
Fix links to subheader when TOC is present It was observed (in nim-lang#20112) that links to 2nd- (and subsequent) -level headings fail if TOC is present, e.g.: ```nim .. contents:: Type relations ============== Convertible relation -------------------- Ref. `Convertible relation`_ ``` The problem here is that links are resolved in `rst.nim` but later `rstgen.nim` fixes ("fixes") anchors to make them unique so that TOC always works (if e.g. there was another sub-section like "Convertible relation"). The solution implemented in this PR is to move that fix-up of anchors into `rst.nim`, so that link resolution could know final anchors. The bug seems to be added in nim-lang#2332 in 2015, that is it is present in Nim 1.0.
capocasa
pushed a commit
to capocasa/Nim
that referenced
this pull request
Mar 31, 2023
Markdown link migration part 1 Also the warning is improved a bit. Local links (targeting inside its document) which had had a full anchor were turned into concise form. The very fact that they existed may be due to the bug in reference to subsections fixed nim-lang#20279, now they are working well (both in RST syntax and new Pandoc Markdown syntax implemented in nim-lang#20304)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It was observed (in #20112)
that links to 2nd- (and subsequent) -level headings
fail if TOC is present, e.g.:
The problem here is that links are resolved in
rst.nimbut laterrstgen.nimfixes ("fixes") anchors to make them unique so thatTOC always works (if e.g. there was another sub-section like
"Convertible relation").
The solution implemented in this PR is to move that fix-up of anchors
into
rst.nim, so that link resolution could know the final anchors.The bug is present in Nim 1.0, it seems to be added in #2332 in 2015.
This PR currently affects only RST syntax because there is no Markdown syntax for that (but it will be added eventually, see #20127).