Wrap docstrings to 79 chars and check with flake8 #212
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
andverde/__init__.py
.