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

Always use dim argument #16

Open
OriolAbril opened this issue Jul 9, 2024 · 1 comment
Open

Always use dim argument #16

OriolAbril opened this issue Jul 9, 2024 · 1 comment

Comments

@OriolAbril
Copy link
Member

OriolAbril commented Jul 9, 2024

I have just seen that xarray has recently (this May) undergone an effort to standardize the dim/dims/dimensions arguments to always use dim. I think we should do the same to keep things consistent and avoid confusion (with ourselves being the main confused people too).

The only places were dims is still used are constructors such as xarray.DataArray(..., dims=). Which is the agreed on convention.

Extra: should this also affect sample_dims->sample_dim in rcParams and batteries included plots?

Ref: https://docs.xarray.dev/en/latest/whats-new.html#id16

@OriolAbril
Copy link
Member Author

OriolAbril commented Aug 1, 2024

We tentatively agree to follow xarray and always use dim instead of dims. However, sample_dims being a different concept will continue to be sample_dims not sample_dim cc @aloctavodia. We'll see how we sleep on the decision

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

No branches or pull requests

1 participant