add doctest examples for core xarray APIs #10953
Open
+242
−4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR Implements part of the request in issue #6793 by adding simple and runnable doctest-ready examples for a subset of core APIs. Other methods noted in the issue remain out-of-scope for this PR. It also fixes a couple of outdated/broken examples and adds some more See Also links.
New examples were added for some of my favourite methods including:
load_datasetload_dataarrayopen_datasetopen_dataarrayopen_groupsopen_mfdatasetinfer_freqpolyvaldecode_cfDataset.computeDataset.persistDataset.drop_dimsget_optionsunify_chunksThis PR fixes several outdated or inconsistent doctests: updating the monthly frequency example in
save_mfdatasetand modernising See Also references.Happy to adjust formatting (e.g., skip flags, repr looseness, stylistic preferences) based on maintainer feedback.