autodoc: Only add 'alias of' line for aliases having no docstr (#12484) #12498
+106
−25
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
autodoc: Do not add an 'alias of ...' line using the `autodata` and `autoattribute` directives for generic aliases having docstrings.
felixblanke
force-pushed
the
autodoc-add-alias-of-only-if-no-docstr
branch
from
04b3756 to
50d7791
Compare
picnixz
reviewed
Jul 20, 2024
| @@ -2152,7 +2152,8 @@ def add_content(self, more_content: StringList | None) -> None: | |||
| if not more_content: | |||
| more_content = StringList() | |||
|
|
|||
| self.update_content(more_content) | |||
| if not self.get_module_comment(self.objpath[-1]): | |||
There was a problem hiding this comment.
The issue with this path is that it entirely disallows a documenter to subclass update_content. An alternative is to provide a method, say should_update_content which returns a boolean determining whether the directive should update the content or not. By default, this would return not self.get_module_comment(self.objpath[-1]) and subclasses could decide what to do.
EDIT: if this is how the class directive proceeds, you can keep this logic.
There was a problem hiding this comment.
This is handled the same way in ClassDocumenter
sphinx/sphinx/ext/autodoc/__init__.py
Line 1861 in 45f3cd6
So shall we keep it this way for now?
Co-authored-by: Bénédikt Tran <[email protected]>
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.
Subject: autodoc: Do not add an 'alias of ...' line using the
autodataandautoattributedirectives for type aliases having docstrings.Feature or Bugfix
(probably bugfix as this is the behavior for the
autoclassdirective)Purpose
Currently, if the directive
autodataorautoattributeare used on a type alias, the textalias of <type>is added to the end of the documentation text – even if a docstring for the alias is provided.This is inconsistent with the
autoclassdirective that does not add such a line if a docstring is provided.Detail
The 'alias of...' line is added by the method
update_contentofGenericAliasMixin. This PR adds a check s.t. this method is only called if no docstring is provided by the user.Relates