pydocstringformatter icon indicating copy to clipboard operation
pydocstringformatter copied to clipboard

Cut lines that exceed a number of caracter and reorganize docstrings

Open Pierre-Sassoulas opened this issue 3 years ago • 2 comments

Like prettier does. Must not break numpy/google style docstrings. Should not break the first line, except if there is multiple sentence then it should take only the first one and move the rest in the body of the docstring.

Default to 88 char like black, but should probably be configurable ?

Pierre-Sassoulas avatar Jan 02 '22 22:01 Pierre-Sassoulas

- [ ] Line wrapping after certain line length (make line length configurable, search for settings of other tools (black, pylint)) - [ ] Break up multiple sentences on first line into summary and main block (see PEP 256) - [ ] Handle numpy/google style docstrings gracefully with line wrapping Outdated.

DanielNoord avatar Jan 03 '22 08:01 DanielNoord

Current status of TODO:

  • [ ] Search for settings of other tools (black, pylint) of max-line-length after #105
  • [ ] Handle line-wrapping of descriptions
  • [ ] Handle numpy/google style docstrings gracefully with line wrapping

I'm going to move this from the 0.6.0 milestone as I'm quite happy with releasing 0.6.0 with inclusion of only summary wrapping.

DanielNoord avatar May 23 '22 10:05 DanielNoord