Improve API doc for users
オープン
まだ誰も着手していません。
Documentation
help wanted
task
- 主要言語
- Python
- スター
- 1.8k
- フォーク
- 570
- 平均マージ
- 1日 10時間
- マージ済み PR（30日）
- 24
説明
The problem
Just published API doc.
https://appium.github.io/python-client-sphinx/
However, it is just first revision and could be more user friendly.
References
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず https://appium.github.io/python-client-sphinx/ に公開されている API ドキュメントを確認し、次に issue に記載されている Sphinx の例および Napoleon Config のリファレンスと比較してください。ユーザーに影響する具体的な不足を特定してドキュメントを更新します。API リファレンスがより使いやすくなれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100