NOTICE: This library is no longer being developed. Use Ensaio instead (https://www.fatiando.org/ensaio). -- Download geophysical models/datasets and load them in Python
BSD 3-Clause "New" or "Revised" License
34
stars
15
forks
source link
Use positional only arguments in all functions #31
Python has syntax for only allowing keyword arguments to be specified by
users using the keyword. For example fetch_prem(load=False) would be
valid while fetch_prem(False) would not. This is good because it
prevents bugs down the line if we add or remove parameters.
We should adopt this for all our other projects.
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.
Python has syntax for only allowing keyword arguments to be specified by users using the keyword. For example
fetch_prem(load=False)
would be valid whilefetch_prem(False)
would not. This is good because it prevents bugs down the line if we add or remove parameters.We should adopt this for all our other projects.
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.