Fix #6914: Emit a detailed warning when failed to resolve :ref: #8075
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
tk0miya
commented
Aug 8, 2020
| @@ -1106,8 +1104,27 @@ def note_labels(self, env: "BuildEnvironment", docname: str, document: nodes.doc | |||
| RemovedInSphinx40Warning, stacklevel=2) | |||
|
|
|||
|
|
|||
| def warn_missing_reference(app: "Sphinx", domain: Domain, node: pending_xref) -> bool: | |||
There was a problem hiding this comment.
Alternatively, it is also good to add a new method to the Domain like Domain.warn_missing_reference(node). I don't have a special reason to choose an event for such a purpose. Okay to move the method.
There was a problem hiding this comment.
I think it is not necessary > Domain.warn....
tk0miya
force-pushed
the
6914_detailed_warning_for_missing_ref
branch
from
1ab0e35
to
42df70e
Compare
tk0miya
force-pushed
the
6914_detailed_warning_for_missing_ref
branch
from
42df70e
to
3863ab3
Compare
tk0miya
force-pushed
the
6914_detailed_warning_for_missing_ref
branch
from
3863ab3
to
4472286
Compare
shimizukawa
approved these changes
Nov 1, 2020
| @@ -1106,8 +1104,27 @@ def note_labels(self, env: "BuildEnvironment", docname: str, document: nodes.doc | |||
| RemovedInSphinx40Warning, stacklevel=2) | |||
|
|
|||
|
|
|||
| def warn_missing_reference(app: "Sphinx", domain: Domain, node: pending_xref) -> bool: | |||
There was a problem hiding this comment.
I think it is not necessary > Domain.warn....
tk0miya
commented
Nov 1, 2020
tk0miya
force-pushed
the
6914_detailed_warning_for_missing_ref
branch
3 times, most recently
from
3964d50
to
cd54210
Compare
…ref: To be clear the ambiguous warning for missing-reference :ref:, this separates the warning to missing-label and missing-caption. To emit a warning dynamically, this also adds a new event: `warn-missing-reference` to customize warning messages via event handlers.
tk0miya
force-pushed
the
6914_detailed_warning_for_missing_ref
branch
from
cd54210
to
0e98e9b
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Feature or Bugfix
Purpose
this separates the warning to missing-label and missing-caption.
warn-missing-referenceto customize warning messages via eventhandlers.