fatiando / erizo

DISCONTINUED. Elastic multi-component interpolation of GPS/GNSS ground displacement.

https://www.fatiando.org/erizo

BSD 3-Clause "New" or "Revised" License

5 stars 8 forks source link

Use flake8 to check docstring line lengths #2

Closed leouieda closed 4 years ago

leouieda commented 4 years ago

Docstrings need to be 79 characters wide since Jupyter/IPython (and other IDEs) don't really render the text. So longer lines get wrapped making docstrings unreadable.

Reminders

[ ] Run make format and make check to make sure the code follows the style guide.
[ ] Add tests for new features or tests that would have caught the bug that you're fixing.
[ ] Add new public functions/methods/classes to doc/api/index.rst.
[ ] Write detailed docstrings for all functions/methods.
[ ] If adding new functionality, add an example to the docstring, gallery, and/or tutorials.

welcome[bot] commented 4 years ago

💖 Thanks for opening this pull request! 💖

Please make sure you read our Contributing Guide and abide by our Code of Conduct.

A few things to keep in mind:

Remember to run make format to make sure your code follows our style guide.
If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
No matter what, we are really grateful that you put in the effort to do this! ⭐

codecov[bot] commented 4 years ago

Codecov Report

Merging #2 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master       #2   +/-   ##
=======================================
  Coverage   65.82%   65.82%           
=======================================
  Files           3        3           
  Lines          79       79           
  Branches       11       11           
=======================================
  Hits           52       52           
  Misses         27       27

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 84c0122...ac32460. Read the comment docs.