DOC: Make explanation image for Reprs

オープン
#11,031 コメント 4 件 リアクション 4 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

この issue では対象ファイルもテストも指定されていないため、まず xarray の表示 repr と HTML repr、および太字の座標、括弧で囲まれた名前、2D 座標、dataset の次元について列挙された質問を確認する。完了の条件は、明確な注釈付きの説明画像を作成し、それをドキュメントのどこに追加すべきかを判断することである。

索引モデルが issue の本文から書いたものです。

説明

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)
主要言語
Python
スター
4.2k
フォーク
1.5k
平均マージ
2日 21時間
マージ済み PR(30日)
74

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

pydata/xarray のほかの issue

pydata/xarray の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。