[mkdocs] return type format in plotly.figure_factory functions
オープン
まだ誰も着手していません。
documentation
P2
- 主要言語
- Python
- スター
- 18.8k
- フォーク
- 2.8k
- 平均マージ
- 16時間 26分
- マージ済み PR（30日）
- 21
説明
- After converting the docstrings of each function into numpy style, the return types are not as clear and might want to be edited for clarity. For example, the following return type for
create_facet_grid:
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
plotly.figure_factory の各関数にある NumPy スタイルの docstring を確認し、issue にある create_facet_grid の戻り値の型の例から始めます。対象となる関数全体で戻り値の型を一貫して明確にし、各戻り値を明確に文書化して完了を示します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100