Comment about keeping docstrings to 79 characters #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@fatiando/contributors please keep this in mind going forward. We'd also welcome help reformatting the existing docstrings to fit within 79 characters (most projects will need this). |
This was referenced Nov 8, 2019
leouieda
added a commit
to fatiando/pooch
that referenced
this pull request
Nov 14, 2019
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.
5 tasks
leouieda
added a commit
to fatiando/pooch
that referenced
this pull request
Nov 14, 2019
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.
leouieda
added a commit
to fatiando/pooch
that referenced
this pull request
Nov 18, 2019
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
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.
Otherwise Jupyter/IPython won't render the docstrings nicely in tab completion.
Fixes #9 and fatiando/verde#177