Update Custom Indexes section in api.rst #10517
Merged
Conversation
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
A couple of xarray-tutorial paths have changed.
Hmmm, yeah looks like some last minute changes for the scipy 2025 tutorial :) xarray-contrib/xarray-tutorial#334 |
scottyhq
reviewed
Jul 9, 2025
doc/api.rst
Outdated
| @@ -1571,12 +1571,22 @@ Custom Indexes | |||
| ============== | |||
| .. currentmodule:: xarray | |||
|
|
|||
| Default, pandas-backed indexes built-in to Xarray: | |||
There was a problem hiding this comment.
I'm wondering about renaming this entire section Custom Indexes -> Indexes, and promoting it up so that it's underneath other core data structures (under Coordinates)
Also a quick update here would be nice https://xray--10517.org.readthedocs.build/en/10517/internals/internal-design.html#internal-design (but that can also happen later as part of #10323)
There was a problem hiding this comment.
I moved half of it up, and left the "build new indexes" pieces down where they are now.
The internal design page will require more time than I have now.
dcherian
added a commit
to jsignell/xarray
that referenced
this pull request
Jul 18, 2025
* main: (94 commits) Restructure API documentation into organized sections (pydata#10540) Fix convert calendar with different dimension name (pydata#10544) Fix kerchunk error in docs build (pydata#10545) Call super().__init__() in st.SearchStrategy subclasses (pydata#10543) CI: update actions location (pydata#10529) meta: Fix labeler topic-documentation (pydata#10524) drop_vars: use emit_user_level_warning (pydata#10528) Pydap flaky tests (pydata#10525) Remove test skip (pydata#10523) Improve warning message and tests for timedelta decoding (pydata#10508) Add dev whats-new (pydata#10522) Add release notes for v2025.07.1 (pydata#10520) Updates for Zarr 3 Dtypes (pydata#10456) Update Custom Indexes section in api.rst (pydata#10517) Expression not assigned (pydata#10507) Raise if `Index.create_variables` returns more variables than passed in through `set_xindex` (pydata#10503) Allow setting (or skipping) new indexes in open_dataset (pydata#8051) doc: add Pandas(Multi)Index to api reference (pydata#10515) Update pre-commit hooks (pydata#10510) Update pre-commit ruff legacy alias (pydata#10511) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A couple of xarray-tutorial paths have changed.