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.

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

Use keywords for default arguments in tests and examples #327

Merged
merged 1 commit into from
May 26, 2021

Conversation

santisoler
Copy link
Member

Explicitly pass default arguments with their corresponding keywords on tests
and examples. Particularly for grid_coordinates and BaseGridder.grid calls.
It's better if we instruct people to use keywords of default arguments instead
of passing them by order, this way can add or change the order of default
arguments without breaking backward compatibility.

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 and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

Explicitly pass default arguments with their corresponding keywords on
tests and examples. Particularly for grid_coordinates and
BaseGridder.grid calls.
@santisoler santisoler requested a review from leouieda May 20, 2021 18:29
Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏽

We should think about making our functions/methods take keyword-only arguments. That would have avoided this type of thing.

@santisoler santisoler merged commit 1ccd33b into master May 26, 2021
@santisoler santisoler deleted the default-arguments branch May 26, 2021 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants