Get correct source code link for decorated functions #22044
Merged
Conversation
This file contains hidden or 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
for sphinx.ext.linkcode
|
Well, that was far easier to fix than I expected (I was worried we would have to write |
tacaswell
approved these changes
Dec 23, 2021
timhoffm
approved these changes
Dec 23, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Dec 23, 2021
tacaswell
added a commit
that referenced
this pull request
Dec 23, 2021
…044-on-v3.5.x Backport PR #22044 on branch v3.5.x (Get correct source code link for decorated functions)
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.
for sphinx.ext.linkcode
PR Summary
For decorated functions, get the source code of the decorated function instead of the decorator.
Closes #22039.
The source link of the example from the issue MicrosecondLocator.set_data_interval points to the correct function now.
PR Checklist
Tests and Styling
pytestpasses). --> I didn't include a test aslinkcode_resolvewas uncovered before.flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).