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

Warn on index creation #170

Merged
merged 6 commits into from
Jul 2, 2024
Merged

Warn on index creation #170

merged 6 commits into from
Jul 2, 2024

Conversation

TomNicholas
Copy link
Member

@TomNicholas TomNicholas commented Jul 1, 2024

Currently passing indexes=None to open_virtual_dataset isn't properly supported. But this is also the default (to give behaviour most similar to xr.open_dataset). Whilst all the documentation examples use the recommended indexes={}, this PR actually adds a UserWarning telling you to use indexes={}.

@TomNicholas TomNicholas added the documentation Improvements or additions to documentation label Jul 1, 2024
@TomNicholas TomNicholas merged commit 2822961 into main Jul 2, 2024
7 checks passed
@TomNicholas TomNicholas deleted the warn_on_index_creation branch July 2, 2024 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant