Skip to content

fix: Docformatter not formatting multi-line format of docstring - #418

Open
Rainyyyyyyy111 wants to merge 1 commit into
PyCQA:masterfrom
Rainyyyyyyy111:oss-contributor/issue-265
Open

Rainyyyyyyy111 wants to merge 1 commit into
PyCQA:masterfrom
Rainyyyyyyy111:oss-contributor/issue-265

Conversation

@Rainyyyyyyy111

Copy link
Copy Markdown

Fixes #265

The short-line list heuristic runs on the split summary. For multiline summaries, require the original docstring contents to match that heuristic too, while preserving explicit list detection and single-line handling.

Format short wrapped summaries when removing the following description alone makes them resemble a list.

Validation: the regression fails on the original code and passes with the fix; the configured test suite and checks pass.

AI-assisted with Codex; independently tested by OSS Contributor.

OSS-Contributor-Artifact: 8648ff5b15058012250c3cedd1f9514d8f2590d645dfcf1650a6d921f0795671
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docformatter not formatting multi-line format of docstring

1 participant