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

Harmonize parameter naming for selections/filters #244

Open
JGuetschow opened this issue Jun 26, 2024 · 1 comment
Open

Harmonize parameter naming for selections/filters #244

JGuetschow opened this issue Jun 26, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@JGuetschow
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Parameters to limit functions to a selection of the dataset use different names. In the downscaling function we use sel and in the aggregation functions we use filter

Describe the solution you'd like

Parameters that fulfill the same purpose should have the same name so users don't have to remerber different names for different functions.

Additional context

We've not used the new aggregation functions a lot, so it should be acceptable work to change the parameter name for these functions and adapt the code that already uses the functions.

@JGuetschow JGuetschow added the enhancement New feature or request label Jun 26, 2024
@JGuetschow JGuetschow self-assigned this Jun 26, 2024
@mikapfl
Copy link
Member

mikapfl commented Jul 3, 2024

I agree, it would be great to have a self-consistent API. We could also support the old name filter for legacy compatibility, but document that it is better to use sel instead.

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

No branches or pull requests

2 participants