DOC: Make explanation image for Reprs

Abierto
#11,031 4 comentarios 4 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
30/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

El issue no indica ningún archivo objetivo ni ninguna prueba; empieza revisando las representaciones impresas y HTML de xarray, así como las preguntas enumeradas sobre coordenadas en negrita, nombres entre paréntesis, coordenadas 2D y dimensiones de dataset. El trabajo estará terminado cuando se produzca una imagen explicativa clara y anotada y se determine dónde debería añadirse a la documentación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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)
Lenguaje dominante
Python
Estrellas
4.2k
Forks
1.5k
Merge medio
2 d 21 h
PR fusionados (30 d)
74

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de pydata/xarray

Todos los issues de pydata/xarray

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.