Skip to content

Unify the type preprocessing logic in Napoleon #13146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AA-Turner merged 3 commits into from
Jan 5, 2025
Merged

Unify the type preprocessing logic in Napoleon #13146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ad6cc7
Napoleon: Move the type preprocessing code
cbarrick Nov 20, 2024
ab8cf47
Napoleon: Unify the type preprocessing logic
cbarrick Nov 20, 2024
3c64f89
Record the change to Napoleon type preprocessing in CHANGES.rst
AA-Turner Jan 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Contributors
* Bruce Mitchener -- Minor epub improvement
* Buck Evan -- dummy builder
* Charles Duffy -- original graphviz extension
* Chris Barrick -- Napoleon type preprocessing logic
* Chris Holdgraf -- improved documentation structure
* Chris Lamb -- reproducibility fixes
* Christopher Perkins -- autosummary integration
Expand Down
3 changes: 3 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ Features added
Patch by Nicolas Peugnet.
* #13144: Add a ``class`` option to the :rst:dir:`autosummary` directive.
Patch by Tim Hoffmann.
* #13146: Napoleon: Unify the type preprocessing logic to allow
Google-style docstrings to use the optional and default keywords.
Patch by Chris Barrick.

Bugs fixed
----------
Expand Down
Loading
Loading