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

Configure flake8 to check for docstrings larger than 79 characters #1

Open
santisoler opened this issue Nov 8, 2019 · 0 comments
Open

Configure flake8 to check for docstrings larger than 79 characters #1

santisoler opened this issue Nov 8, 2019 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

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 configure flake8 to check for this when running the style checks on the package template.
This can be done by setting max-doc-length to 79 characters on the flake8 configuration under setup.cfg.
@santisoler santisoler added enhancement New feature or request help wanted Extra attention is needed labels Nov 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@santisoler