PR: Overhaul, fix and improve docstring generation (Editor)#25558

Draft

CAM-Gerlach wants to merge 29 commits intospyder-ide:masterfrom

CAM-Gerlach:fix-generate-docstring

Commits on Jan 26, 2026

Format generated docstring according to style guides

rhkarls
authored and
CAM-Gerlach
committed
Update Editor docstring.py header, fix imports & improve mod docstring
CAM-Gerlach
committed
Refactor Editor docstring.py to be simpler, cleaner & more Pythonic
CAM-Gerlach
committed

Commits on Feb 3, 2026

Format test_docstring.py w/Black for better readability
CAM-Gerlach
committed
Factor common setup in test_docstring.py tests into reusable fixtures
CAM-Gerlach
committed
De-duplicate non-DRY test functions in test_docstring.py
CAM-Gerlach
committed
Make param order consistent in docstring.py tests & rm unneeded
CAM-Gerlach
committed
Simplify test_editor_docstring_delayed_popup() & speed up by 2x
CAM-Gerlach
committed
Use common test cases/IDs in test_docstring & factor out of functions
CAM-Gerlach
committed
Split docstring gen test cases into DRY dataclasses w/granular fields
CAM-Gerlach
committed
Test docstring gen on multiline defs & further refactor test fns
CAM-Gerlach
committed
Move docstring generator test cases to external files
CAM-Gerlach
committed
Fix Generate Docstring not working on Black-formatted func signatures
CAM-Gerlach
committed
Fix bug in function start detection for Generate Docstring action
CAM-Gerlach
committed
Increase/standardize docstring gen max lengths w/named consts
CAM-Gerlach
committed
Fix generate docstring bug with trailing comma causing empty param
CAM-Gerlach
committed
Skip period & desc when generating docstrings for fns returning None
CAM-Gerlach
committed
Fix false positives & negatives in docstring gen return/yield detect
CAM-Gerlach
committed
Support generating Sphinxdoc return type(s) from func body
CAM-Gerlach
committed
Don't expand tuples to multiple return values per Googledoc spec
CAM-Gerlach
committed
Support formatting tuple return annotations in generated docstrings
CAM-Gerlach
committed
Collapse annotated return types in generated docstrings to one line
CAM-Gerlach
committed
Make line breaks in generated docstrings consistent between sections
CAM-Gerlach
committed
Fix section order in Sphinxdoc & remove optional from param type
CAM-Gerlach
committed
Incorporate existing docstring content as description in generated one
CAM-Gerlach
committed
Remove dupe copy of existing docstring when generating a new one
CAM-Gerlach
committed
Refactor _generate_<format>_doc() into smaller fns by section
CAM-Gerlach
committed
Further refactor generate_docstring fns for cleaner string building
CAM-Gerlach
committed
Parse existing docstring sections & integrate into generated docstring
CAM-Gerlach
committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

PR: Overhaul, fix and improve docstring generation (Editor)#25558

PR: Overhaul, fix and improve docstring generation (Editor)#25558
CAM-Gerlach wants to merge 29 commits intospyder-ide:masterfrom
CAM-Gerlach:fix-generate-docstring

Commits on Jan 26, 2026

Format generated docstring according to style guides

Update Editor docstring.py header, fix imports & improve mod docstring

Refactor Editor docstring.py to be simpler, cleaner & more Pythonic

Commits on Feb 3, 2026

Format test_docstring.py w/Black for better readability

Factor common setup in test_docstring.py tests into reusable fixtures

De-duplicate non-DRY test functions in test_docstring.py

Make param order consistent in docstring.py tests & rm unneeded

Simplify test_editor_docstring_delayed_popup() & speed up by 2x

Use common test cases/IDs in test_docstring & factor out of functions

Split docstring gen test cases into DRY dataclasses w/granular fields

Test docstring gen on multiline defs & further refactor test fns

Move docstring generator test cases to external files

Fix Generate Docstring not working on Black-formatted func signatures

Fix bug in function start detection for Generate Docstring action

Increase/standardize docstring gen max lengths w/named consts

Fix generate docstring bug with trailing comma causing empty param

Skip period & desc when generating docstrings for fns returning None

Fix false positives & negatives in docstring gen return/yield detect

Support generating Sphinxdoc return type(s) from func body

Don't expand tuples to multiple return values per Googledoc spec

Support formatting tuple return annotations in generated docstrings

Collapse annotated return types in generated docstrings to one line

Make line breaks in generated docstrings consistent between sections

Fix section order in Sphinxdoc & remove optional from param type

Incorporate existing docstring content as description in generated one

Remove dupe copy of existing docstring when generating a new one

Refactor _generate_<format>_doc() into smaller fns by section

Further refactor generate_docstring fns for cleaner string building

Parse existing docstring sections & integrate into generated docstring