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 #207

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

Wrap all docstrings to 79 characters #207

santisoler opened this issue Nov 8, 2019 · 0 comments · Fixed by #212
Labels
documentation Improvements or additions to documentation

Comments

@santisoler
Copy link
Member

Description of the desired feature

After #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 Verde 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 the documentation Improvements or additions to documentation label Nov 22, 2019
leouieda added a commit that referenced this issue Nov 25, 2019
@leouieda
Wrap docstrings to 79 chars and check with flake8
120a1f6 
Wrap all docstrings to 79 characters of API functions. Exclude examples
(docstrings are rendered by sphinx-gallery). Set `max-doc-length=79`
characters to make flake8 check if any docstring exceeds it. The setting
checks comments as well and we found no way of disabling that. So we'll
format comments to 79 characters for consistency as well. Minor
modifications to the first line of some docstrings was required to make
them fit into a single line. Also made minor modifications on some
doctests to wrap to 79 characters.

Fixes #207
@leouieda leouieda mentioned this issue Nov 25, 2019
Merged
5 tasks
leouieda added a commit that referenced this issue Nov 25, 2019
@leouieda
Wrap docstrings to 79 chars and check with flake8 (#212)
9c517e2 
Wrap all docstrings to 79 characters of API functions. Exclude examples
(docstrings are rendered by sphinx-gallery). Set `max-doc-length=79`
characters to make flake8 check if any docstring exceeds it. The setting
checks comments as well and we found no way of disabling that. So we'll
format comments to 79 characters for consistency as well. Minor
modifications to the first line of some docstrings was required to make
them fit into a single line. Also made minor modifications on some
doctests to wrap to 79 characters.

Fixes #207
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Wrap docstrings to 79 chars and check with flake8 fatiando/verde
2 participants
@leouieda @santisoler