Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cut lines that exceed a number of caracter and reorganize docstrings #7

Open
Pierre-Sassoulas opened this issue Jan 2, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@Pierre-Sassoulas
Copy link
Collaborator

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 ?

@DanielNoord
Copy link
Owner

DanielNoord commented Jan 3, 2022

- [ ] 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.

@Pierre-Sassoulas Pierre-Sassoulas added the enhancement New feature or request label Jan 3, 2022
Pierre-Sassoulas added a commit that referenced this issue Jan 3, 2022
Pierre-Sassoulas added a commit that referenced this issue Jan 4, 2022
Pierre-Sassoulas added a commit that referenced this issue Jan 8, 2022
@DanielNoord DanielNoord added this to the 0.4.0 milestone Jan 10, 2022
@DanielNoord DanielNoord modified the milestones: 0.5.0, 0.6.0 Mar 13, 2022
@DanielNoord
Copy link
Owner

Current status of TODO:

  • Search for settings of other tools (black, pylint) of max-line-length after Max line length #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 DanielNoord removed this from the 0.6.0 milestone May 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants