Fix #9481: autosummary: some warnings contain non-existing filenames #9498
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
Jul 25, 2021
| @@ -3388,13 +3388,13 @@ def run(self) -> List[Node]: | |||
| stack: List[Symbol] = [] | |||
| else: | |||
| parser = DefinitionParser(self.arguments[0], | |||
| location=self.get_source_info(), | |||
| location=self.get_location(), | |||
There was a problem hiding this comment.
FYI: Please take care to use get_location() for logging @jakobandersen
…filenames `SphinxDirective.get_source_info()` returns the pair of fullpath of source and current line number. But our logging module expects one of these: * A string consists of fullpath and current line number * A pair of docname and current line number To show correct location for warnings, this adds `get_location()` method that returns the former one. Note: This also modifies C/C++ domains.
tk0miya
force-pushed
the
9481_autosummary_warnings
branch
from
c70b0da
to
774b0b0
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
SphinxDirective.get_source_info()returns the pair of fullpath ofsource and current line number. But our logging module expects one of
these:
To show correct location for warnings, this adds
get_location()methodthat returns the former one.
Note: This also modifies C/C++ domains.
refs: Some warnings contain non-existing paths #9481