Close #5603: autodoc: Allow to refer to a python object using canonical name #9026
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
added
type:enhancement
tk0miya
force-pushed
the
5603_autodoc_canonical
branch
from
33d8523
to
c4eb528
Compare
tk0miya
commented
Mar 23, 2021
tk0miya
force-pushed
the
5603_autodoc_canonical
branch
2 times, most recently
from
151def0
to
fbdcf42
Compare
tk0miya
commented
Mar 24, 2021
shimizukawa
approved these changes
Mar 27, 2021
tk0miya
force-pushed
the
5603_autodoc_canonical
branch
2 times, most recently
from
5ff2c37
to
d8530e3
Compare
…ng canonical name This generates `:canonical:` option for `:py:class:` directive if the target class is imported from other module. It allows users to refer it using both the new name (imported name) and the original name (canonical name). It helps a library that implements some class in private module (like `_io.StringIO`), and publish it as public module (like `io.StringIO`).
tk0miya
force-pushed
the
5603_autodoc_canonical
branch
from
d8530e3
to
acf66bc
Compare
|
Thank you for reviewing @shimizukawa ! Now merging. |
This was referenced Mar 27, 2021
This was referenced Mar 27, 2021
|
Long-awaited enhancement ~ 👍 |
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
:canonical:option for:py:class:directive if thetarget class is imported from other module. It allows users to refer it
using both the new name (imported name) and the original name (canonical
name).
_io.StringIO), and publish it as public module (likeio.StringIO).Remaining Tasks
Support imported functions