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

Rename "spacing" arguments to something more sensible #416

Open
leouieda opened this issue Nov 28, 2023 · 1 comment
Open

Rename "spacing" arguments to something more sensible #416

leouieda opened this issue Nov 28, 2023 · 1 comment
Labels
enhancement Idea or request for a new feature
Milestone

Comments

@leouieda
Copy link
Member

There are many places (like block_split, BlockReduce, BlockKFold, etc) that take a "spacing" argument but aren't directly related to generating grids. This is because these functions/classes using grid_coordinates internally to generate blocks. It doesn't really make much sense for these to be called "spacing" when they actually mean something like "block_size" instead.

We should:

  1. Make a list of all occurrences of this.
  2. Rename the arguments to something more sensible.
  3. Think if they really need other arguments like "shape" and "adjust" (they probably don't).

This is a breaking change and so should be reserved for Verde 2.0.

@leouieda leouieda added the enhancement Idea or request for a new feature label Nov 28, 2023
@leouieda leouieda added this to the v2.0.0 milestone Nov 28, 2023
@leouieda
Copy link
Member Author

Thanks to @indiauppal for pointing this out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Idea or request for a new feature
Projects
None yet
Development

No branches or pull requests

1 participant