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

Make parameter validation methods private #55

Merged
merged 1 commit into from
Oct 8, 2020
Merged

Make parameter validation methods private #55

merged 1 commit into from
Oct 8, 2020

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Oct 8, 2020

The check_* methods were appearing in the API list, which isn't
desirable since they are not meant to be used directly. Make them
private (with a leading _) to avoid this. While we're at it, use
f-strings to make error messages shorter.

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.

The `check_*` methods were appearing in the API list, which isn't
desirable since they are not meant to be used directly. Make them
private (with a leading `_`) to avoid this. While we're at it, use
f-strings to make error messages shorter.
Copy link
Member

@santisoler santisoler left a comment

Choose a reason for hiding this comment

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

I completely missed to make this methods private. Thanks for the fix!

@leouieda leouieda merged commit 49a3abb into master Oct 8, 2020
@leouieda leouieda deleted the checks branch October 8, 2020 13:15
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