Provide proper SDK Documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、Python SDK で生成されたフィールド説明を、issue にリンクされている Go SDK の例と比較します。ドキュメント生成のエントリーポイントと、影響を受ける API モデルの範囲を特定します。Python ユーザーが繰り返しのプレースホルダーテキストではなく、意味のあるプロパティ説明を受け取れるようになれば完了です。
索引モデルが issue の本文から書いたものです。
説明
I see that the go SDK has great API documentation (example).
The python SDK only provides rather useless text parts:
The value to assign to XXX of this YYY.
It would be great if also the python folks can benefit from good documentation.
Thanks!
- 主要言語
- Python
- スター
- 474
- フォーク
- 321
- 平均マージ
- 23分
- マージ済み PR（30日）
- 4
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
oracle/oci-python-sdk のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
oracle/oci-python-sdk#890 · コメント 3 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
oracle/oci-python-sdk#879 · コメント 3 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 66/100
oracle/oci-python-sdk#878 ·
-
SDK
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
oracle/oci-python-sdk#861 · コメント 5 件 ·
-
SDK
難易度 2/5 1〜3時間 初心者へのやさしさ 48/100
oracle/oci-python-sdk#852 ·
oracle/oci-python-sdk の issue をすべて見る
似ている issue
-
area: harness bug status: needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Human-Agent-Society/reef#625 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
learningequality/kolibri#15351 · コメント 2 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
Name consistency オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
eellak/triplestore#65 · コメント 1 件 ·