PyCQA / PyCQA/docformatter

Missing indentation as in example

Open
#278 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C: convention community feedback P: enhancement U: medium
Dominant language
Python
Stars
598
Forks
93
PR merge metrics
No merged PRs in 30d

Description

I follow the example in the readme,

Intead of getting this,

def launch_rocket():
    """Launch the rocket.

    Go colonize space.
    """

I got this (no change) ,

def launch_rocket():
    """Launch
the
rocket. Go colonize space."""
 """

Command used: docformatter --in-place example.py

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the README example using example.py and the reported command, docformatter --in-place example.py. Compare the generated docstring with the expected indentation and verify that the command preserves the intended formatting without introducing the shown broken output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.