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.

Sign up for GitHub

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

Jump to bottom

Wrap all docstrings to 79 characters #121

Closed
santisoler opened this issue Nov 8, 2019 · 0 comments · Fixed by #123
Closed

Wrap all docstrings to 79 characters #121

santisoler opened this issue Nov 8, 2019 · 0 comments · Fixed by #123
Labels
good first issue Good for newcomers (doesn’t require deep knowledge of the project)

Comments

@santisoler
Copy link
Member

Description of the desired feature

After fatiando/verde#177 raised by @prisae, fatiando/community#9 and fatiando/community#10 it has been decided that all docstrings must be wrapped to 79 characters per line.
We should warp all the existing docstrings in Pooch to 79 characters and also configure flake8 to check for this when running the style checks.

Sadly, there's no way (yet) to automatically change all docstrings, but at least we can use flake8 to raise lines that fail. This can be done by setting max-doc-length to 79 characters on the flake8 configuration under setup.cfg.
@leouieda leouieda added good first issue Good for newcomers (doesn’t require deep knowledge of the project) help wanted labels Nov 13, 2019
@leouieda leouieda mentioned this issue Nov 14, 2019
Merged
5 tasks
leouieda added a commit that referenced this issue Nov 18, 2019
@leouieda
Make docstrings 79 characters (check with flake8) (#123)
73aca8b 
Docstrings with 88 characters (the Black line length) don't show up nicely in
Jupyter and IPython (since the display is 80 chars). This means that our
docstrings were unreadable. See fatiando/verde#177 fatiando/community#9
fatiando/community#10 for context. Make flake8 check that docstrings (and
comments, sadly) are 79 characters so we can make sure we don't do it again
accidentally. Have to check comments as well because the flake8 flag doesn't
discriminate between them.

Fixes #121
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers (doesn’t require deep knowledge of the project)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Make docstrings 79 characters (check with flake8) fatiando/pooch
2 participants
@leouieda @santisoler