Docformatter not formatting multi-line format of docstring
Open
Nobody has claimed this yet.
C: convention
P: bug
U: high
- Dominant language
- Python
- Stars
- 598
- Forks
- 93
- PR merge metrics
- No merged PRs in 30d
Description
I'm running the latest version of docformatter (as well as 1.7.3, 1.6.5, 1.3.1) with python 3.10.1.
Input:
def launch_rocket():
"""Launch
the
rocket. Go colonize space."""
expected:
def launch_rocket():
"""Launch the rocket.
Go colonize space.
"""
actual output:
def launch_rocket():
"""Launch
the
rocket. Go colonize space.
"""
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue with docformatter and Python 3.10.1 using the input shown in the report, then compare the generated docstring with the expected output. Trace the formatter's handling of multi-line docstrings and add coverage for this case; done means the output matches the expected formatting without regressing existing behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100