cloudevents / cloudevents/sdk-python
Improve the docstring of abstract.CloudEvent
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 342
- フォーク
- 65
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
cloudevents/abstract/event.py の99〜100行目付近を開き、getitem のdocstringを確認します。_attributes のプライベートデータへのアクセスについて報告された混乱を理解するため、issue #246 を読みます。docstringで event.get() が推奨されない理由を説明し、役立つ例または参照先を含めれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100