scverse / scverse/spatialdata-plot
Adding plotting specific documentation
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 86
- フォーク
- 21
- 平均マージ
- 14時間 50分
- マージ済み PR(30日)
- 3
説明
Comment originally from @MeyerBender, thanks for the feedback!
documentation: in general, I think it would be good to have one or two notebooks that exclusively focus on visualization. Right now, it is very hard to find this in the spatialdata docs. Maybe something similar to this, which shows off the most important plotting functions in spatialproteomics.
Currently we have plotting notebooks but hidden under the "Technology-specific" section in the docs. And we have another notebook in a separate repo (=not really discoverable).
Improving the docs with a visualization-specific notebook that is easily discoverable would be valuable.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、ドキュメントの「Technology-specific」セクションにある plotting notebook と、既存の spatialdata-workshops/notebooks/nb2_static_plotting.ipynb を確認します。主要な plotting 関数と、ドキュメント内で notebook がどのようにリンクされているかを特定します。visualization に焦点を当てた notebook が spatialdata-plot のドキュメントで見つけやすく、重要な plotting 関数を網羅していれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- jupyter-notebook, python
- 領域
- data-visualization, documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 65/100