rST: add warning about duplicate hyperlink target names #13400
Conversation
|
The changes in 4df6239 seem to introduce a large number of false-positive warnings; numbered footnotes, for example, are frequently a source of distraction with this in place. I'll move this pull request back into draft status until I can resolve that problem. |
…tions Re-uses some existing filtering for footnotes and other acceptable duplicates. Some false-positives continue to occur with this change in place; for example, internal hyperlink targets that are subsequently `include`d into other docs.
|
Todo: extend the test coverage to add an example of document that is |
| .. _ambiguous_shared_hyperlink: | ||
|
|
||
| This hyperlink target is declared once and is included by multiple documents. |
There was a problem hiding this comment.
@AA-Turner @picnixz is there a way to determine a unique declaration identifier/path -- e.g. where a hyperlink was defined, instead of where it is used?
When reporting warnings about duplicated anonymous hyperlinks, it'd be nice to be able to indicate clearly that the duplication originates from multiple includes of a common document, instead of weird/confusing warnings about the hyperlinks appearing in multiple documents.
|
The term "anonymous" in the name of this PR is confusing:
Anonymous hyperlink targets don't use a reference name and may be internal or external. Example: In every document, the number of anonymous references must match the number of anonymous targets. |
jayaddison
changed the title
|
Thank you @gmilde - is edited version (rST: add warning about duplicate-declaration hyperlink targets) reasonably accurate? |
|
I'd call it "rST: add warning about duplicate hyperlink target names". |
jayaddison
changed the title
|
Thank you; updated. |
|
Regarding spurious warnings, see also my comment on the issue page. |
Purpose
The goal of this pull request is to identify duplicate internal hyperlink targets -- the presence of these can cause documentation hyperlinks to resolve ambiguously (e.g. sometimes incorrectly) at build-time.
References