Improve the docstring of abstract.CloudEvent
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 48/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
cloudevents/abstract/event.py の99〜100行目付近を開き、getitem のdocstringを確認します。_attributes のプライベートデータへのアクセスについて報告された混乱を理解するため、issue #246 を読みます。docstringで event.get() が推奨されない理由を説明し、役立つ例または参照先を含めれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The getitem of this class goes on to describe that:
providing a reason and perhaps a reference to an example would help developers understand why event.get() is discouraged by this helper method.
For instance, there is confusion in how the private _attributes data should be accessed expressed in https://github.com/cloudevents/sdk-python/issues/246.
- 主要言語
- Python
- スター
- 342
- フォーク
- 65
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
cloudevents/sdk-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
cloudevents/sdk-python#304 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
cloudevents/sdk-python#300 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
cloudevents/sdk-python#291 · コメント 8 件 ·
-
question
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
cloudevents/sdk-python#246 · コメント 5 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
cloudevents/sdk-python#213 · コメント 3 件 · リアクション 1 件 ·
cloudevents/sdk-python の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stephrobert/dsoxlab#238 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
sublimehq/package_control#1780 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
nwg-piotr/nwg-displays#145 ·