Document autolink role for autosummary #13596
Open
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
AA-Turner
reviewed
May 27, 2025
|
|
||
| The ``:autolink:`` role functions as ``:obj:`` when the name referred can be | ||
| resolved to a Python object, and otherwise it becomes simple emphasis. | ||
| This can be used as the default role to make links 'smart'. |
There was a problem hiding this comment.
I think that we should be more cautious here. I recall problems with users who've used this as a default role, where really they wanted to use py:obj. I don't have time to find discussion links, though, sorry.
There was a problem hiding this comment.
I see - I found some past issues in the repo.
How about something like
Suggested change
| This can be used as the default role to make links 'smart'. | |
| This can be used as the default role to make links 'smart', but must be used carefully. For example, in the case of multiple objects having the same name, `autolink` could resolve to the wrong object. |
|
Thank you! One brief comment |
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.
Purpose
Adds a documentation section on the autosummary "autolink" role.
References
Closes #1535