DOC: Make explanation image for Reprs

Open
#11,031 4 comments 4 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

topic-documentation topic-html-repr
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:

Image

or this legend guide:

Image (from the amazing: https://stackoverflow.com/a/43439132)
Dominant language
Python
Stars
4.2k
Forks
1.5k
Avg merge
2d 21h
Merged PRs (30d)
74

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pydata/xarray

All issues in pydata/xarray

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.