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

Deprecate the scatter method of BaseGridder #357

Merged
merged 5 commits into from Oct 26, 2022
Merged

Deprecate the scatter method of BaseGridder #357

merged 5 commits into from Oct 26, 2022

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Dec 23, 2021

The method is a bit useless since we rarely want to predict on random
points. Copy the code to the CheckerBoard function since that's where
it is most useful. Issue a FutureWarning from the base scatter
method.

TODO:

  • Add a test for the new scatter method in CheckerBoard
  • Check the documentation for use of scatter

Fixes #291

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 method is a bit useless since we rarely want to predict on random
points. Copy the code to the `CheckerBoard` function since that's where
it is most useful. Issue a `FutureWarning` from the base `scatter`
method.
@leouieda leouieda added this to the 1.8.0 milestone Apr 24, 2022
@leouieda leouieda marked this pull request as ready for review October 26, 2022 14:00
@leouieda leouieda merged commit 3e8c136 into main Oct 26, 2022
@leouieda leouieda deleted the scatter branch October 26, 2022 15:12
leouieda added a commit that referenced this pull request Nov 16, 2022
The method is a bit useless since we rarely want to predict on random
points. Copy the code to the `CheckerBoard` function since that's where
it is most useful. Issue a `FutureWarning` from the base `scatter`
method.
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.

Deprecate BaseGridder.scatter
1 participant