Document Dataset.load_async and DataArray.load_async#11311
Merged
TomNicholas merged 1 commit intopydata:mainfrom Apr 23, 2026
Merged
Document Dataset.load_async and DataArray.load_async#11311TomNicholas merged 1 commit intopydata:mainfrom
TomNicholas merged 1 commit intopydata:mainfrom
Conversation
Add both methods to the autosummary blocks in doc/api/io.rst so Sphinx generates their reference pages. Without these entries no pages are built, and the :py:meth: cross-references to them in whats-new.rst render as plain text. Co-authored-by: Claude <noreply@anthropic.com>
10 tasks
kylebarron
approved these changes
Apr 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Dataset.load_asyncandDataArray.load_asyncto the autosummary blocks indoc/api/io.rstso Sphinx generates dedicated reference pages for them.Variable.load_asynchad a generated page (it's listed indoc/api-hidden.rst), so the:py:meth:\Dataset.load_async`/:py:meth:`DataArray.load_async`cross-references inwhats-new.rst` rendered as plain text.Reported by @kylebarron in #10327 (comment).
DataTree.load_asyncis not added here because it doesn't exist yet (it was left unchecked in #10327's API checklist).Test plan
xarray.Dataset.load_asyncandxarray.DataArray.load_asyncpages are generated and the whats-new cross-references resolve.[This is Claude Code on behalf of Tom Nicholas]