Dedicated documentation on Alignment?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What is your issue?
I'm writing more documentation for DataTree, and was looking for an in-depth explanation of what Alignment actually is so I can refer to it, but I can't really find one?
The concept of alignment is referred to in multiple places, e.g.
- There is a brief definition of alignment in the terminology page,
- There's some explanation in the context of using
.reindex(), - Some more in the context of automatic alignment during broadcasting,
- Alignment of indexes is referred to in the documentation of
xr.mergeon the Combining page - The closest thing to dedicated documentation I've found is in the explanation of
Dataset.update()on the data structures page. - The docstring for
xr.align()has examples, but no narrative explanation.
But there doesn't appear to be a dedicated section on Alignment anywhere in the narrative docs (or even on the xarray tutorial site). I can't find any explanation of what it means for two Datasets not to align, for example.
This seems like a very fundamental concept to not have dedicated documentation with examples. Maybe I've just missed it?
cc @max-sixty @dcherian @shoyer @flamingbear
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the terminology, indexing, computation, combining, and xr.align() documentation linked in the issue to identify the existing explanations and gaps. Add a dedicated narrative explanation of alignment with examples, including what it means for Datasets not to align, and link it from the relevant existing pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100