DOC: Make explanation image for Reprs
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 was helping someone learn to use xarray and they expressed some confusion for understanding the xarray repr (both html and print). They raise good points about the discoverability of what things mean.
i.e.
- what is a bolded coord?
- what are the names in parens
- thrown off by 2d coords looking like they are 1d in the repr
- confusion on what a dimension is on a dataset. not necessarily jus thte dimensions of the data
I think these confusions could be solved with a well made image with annotations on top of an image of the repr. Similar to this anatomy of a figure from matplotlib:
or this legend guide:
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
The issue names no target file or test; start by reviewing xarray's printed and HTML reprs and the listed questions about bold coordinates, parenthesized names, 2D coordinates, and dataset dimensions. Done means producing a clear annotated explanation image and determining where it should be added to the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100