extlink: Add support for suppressing 'hardcoded link' warnings #10123
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
They were added in v4.4.0, but some projects may prefer to hide them, eg. if hardcoded links appear in docstrings.
jeanas
reviewed
Jan 21, 2022
| @@ -76,7 +76,8 @@ def check_uri(self, refnode: nodes.reference) -> None: | |||
| msg = __('hardcoded link %r could be replaced by an extlink ' | |||
| '(try using %r instead)') | |||
| replacement = f":{alias}:`{match.groupdict().get('value')}`" | |||
| logger.warning(msg, uri, replacement, location=refnode) | |||
| logger.warning(msg, uri, replacement, location=refnode, | |||
| type="extlink", subtype="hardcoded") | |||
There was a problem hiding this comment.
(I'm no maintainer, just someone lurking around.)
I think you also need to update the list of warnings in the documentation of suppress_warnings here:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-suppress_warnings
There was a problem hiding this comment.
Never mind, I'm blind. Sorry.
|
I think it's better to disable the detector instead of suppressing warnings. So I'll adopt #10126 instead of this. |
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.
Subject: Add support for suppressing 'hardcoded link' warnings
Feature or Bugfix
Purpose
These warnings were added in v4.4.0, but some projects may prefer to hide them,
eg. if hardcoded links appear in docstrings.
Relates