Skip to content

Why an index#366

Merged
ianhi merged 17 commits into
mainfrom
why-an-index
Jul 14, 2026
Merged

Why an index#366
ianhi merged 17 commits into
mainfrom
why-an-index

Conversation

@ianhi

@ianhi ianhi commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

rough rough rough draft

ianhi added 3 commits July 13, 2026 12:49
Initial draft of intermediate/indexing/why-an-index.ipynb: an
intuition-first tutorial on why xarray needs indexes and when to build
a custom one.
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions

github-actions Bot commented Jul 14, 2026

Copy link
Copy Markdown

♻️ Preview destroyed

PR preview ♻️ Destroyed ♻️ Destroyed
🔗 Preview https://xarray-contrib-xarray-tutorial-preview-pr-366.surge.sh (already destroyed)
📝 Commitde58ff8
🪵 LogsView logs

🤖 Powered by surge-preview

ianhi and others added 6 commits July 13, 2026 22:09
The handoff/session notes under notes/ are local working docs and should
not be tracked (they were appearing in the draft PR diff). Untrack the
handoff note and gitignore notes/ so working notes stay out of git.
@review-notebook-app

review-notebook-app Bot commented Jul 14, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

keewis commented on 2026-07-14T11:08:07Z
----------------------------------------------------------------

I think you can use a direct reference here: https://mystmd.org/guide/cross-references#link-references


@keewis

keewis commented Jul 14, 2026

Copy link
Copy Markdown
Member

This is really nice, Ian. One thing I would change, though, is to point out that the table only is valid at the time of writing, since it is possible that some third-party libraries will provide these indexes in the future.

I'd probably also go through and replace the LLM dashes with other punctuation to make it feel a bit less artificial (but that's a minor concern).

- Collapse the merge-duplicated notebook down to a single copy
- Simplify PeriodicIndex to a scalar-query exercise with an explicit
  input/return contract; blank the body to hints + a runnable stub and
  add an attach-and-call demo that prints what sel receives
- Rename SliceRuler to DIYRangeIndex and give it the same exercise
  scaffolding (contract comment, print of received dict, stub, demo)
- Generalize the CoordinateTransform forward/reverse description
- Remove the 2-D affine grid section; renumber the fisheye section to
  step 2 of 2 and trim the outline accordingly
@ianhi ianhi marked this pull request as ready for review July 14, 2026 18:15
@ianhi

ianhi commented Jul 14, 2026

Copy link
Copy Markdown
Contributor Author

Thank you justus!

I'd probably also go through and replace the LLM dashes with other punctuation to make it feel a bit less artificial (but that's a minor concern).

this was a side effect of some LLM coding alogn the way. I've now re-written the whole prose myself

@ianhi ianhi merged commit f4ac651 into main Jul 14, 2026
1 of 3 checks passed
@ianhi ianhi deleted the why-an-index branch July 14, 2026 18:18
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

Successfully merging this pull request may close these issues.

2 participants