Fix: Napoleon NumpyDocstring incorrect section ordering #14188
+60
−5
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
Member
|
The |
DavidAGInnovation
force-pushed
the
fix/napoleon-section-ordering
branch
5 times, most recently
from
8fc1fb2 to
1d2b57d
Compare
Author
|
Fixed the CI / Python 3.12 (Docutils 0.21) failure: it was Git’s working-tree-encoding conversion choking on working-tree-encoding=iso-8859.
|
AA-Turner
requested changes
Dec 17, 2025
Member
AA-Turner
left a comment
AA-Turner
left a comment
There was a problem hiding this comment.
please revert all unrelated changes
…x-doc#13180) Implements section reordering in NumpyDocstring._parse to ensure 'Attributes' and 'Methods' sections appear after 'Parameters', matching numpydoc standard logic. This is achieved by collecting sections during parsing then reordering them before generating the final parsed lines.
DavidAGInnovation
force-pushed
the
fix/napoleon-section-ordering
branch
from
d07e1c8 to
f97e19f
Compare
Author
|
Done, the tests are running again. |
Author
|
Will this be merged then? @AA-Turner |
Member
|
There's been no review yet which is the major blocker to merging. It'd be helpful to reviewers to have tests and a CHANGES entry in this PR, though. A |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #13180. Implements section reordering in
NumpyDocstring._parseto ensure 'Attributes' and 'Methods' appear after 'Parameters', matching numpydoc standard logic.