autodoc: fix ordering of class and static methods for groupwise order
#13201
+40
−19
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
AA-Turner
reviewed
Jan 16, 2025
sphinx/ext/autodoc/__init__.py
Outdated
| @@ -456,7 +456,7 @@ def parse_name(self) -> bool: | |||
| self.modname = modname | |||
| self.args = args | |||
| self.retann = retann | |||
| self.fullname = '.'.join((self.modname or '', *self.objpath)) | |||
| self.fullname = '.'.join([self.modname, *self.objpath]) | |||
There was a problem hiding this comment.
We have if not modname: return False just above, so when I checked the implementation of parse_name(), I've taken the liberty of cleaning up this one. Will revert tomorrow and address it in a follow-up PR (I'm quite tight on schedule for the next few days).
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.
I don't have an issue yet (but I'll create one and update the changelog once I'm done) but I've found the issue while working on #13200.
Class and static methods were meant to be ordered before regular methods when using
groupwiseorder but this was not respected until now. The reason is that we callsort_membersbefore callinggenerate(which is fine). However,generate()actually callsimport_objectwhich itself modifiesmember_order(because that's the first time we have the actual object and we can inspect it without relying on static analysis).So, we need to decouple
import_objectfromgenerate. To avoid breaking stuff for now, I've added a private_generate()method which is the actual implementation ofgenerate()so that I can call it separately. Current uses ofgenerate()remain the same.