Improve docstrings for Hooks
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、cloudformation_cli_python_lib パッケージ内で、HookContext を含む公開 Hook インターフェースを探し、生成された ../handlers.py の例および Implement Hook handlers (Python) ドキュメントと比較します。request.hookContext と targetModel がどのように公開されているかを確認します。関連する公開クラスとプロパティに、それらの意味と想定される値を説明する有用な Python docstring があれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Hi there 👋,
It would be nice to have Python docstrings included on the public interfaces when developing hooks.
Would pull requests for docstrings be welcome?
For example, after cfn init for hooks, we have a ../handlers.py that looks similar to this:
In Visual Studio Code, when I hover over cloudformation_cli_python_lib specific classes/properties I don't get any information for what they are, or what to expect.
I couldn't find out what all the request.hookContext properties mean, and what dict keys are available on request.hookContext.targetModel from the Implement Hook handlers (Python) documentation.
In the case of HookContext some docstrings like this would be welcome:
Cheers,
Neil
- 主要言語
- Python
- スター
- 107
- フォーク
- 46
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
aws-cloudformation/cloudformation-cli-python-plugin のほかの issue
-
Support UV オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
Repo alive? オープン
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
aws-cloudformation/cloudformation-cli-python-plugin#270 · コメント 1 件 · リアクション 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
aws-cloudformation/cloudformation-cli-python-plugin#268 · コメント 1 件 · リアクション 2 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
aws-cloudformation/cloudformation-cli-python-plugin#264 · コメント 1 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
aws-cloudformation/cloudformation-cli-python-plugin#263 · コメント 2 件 · リアクション 3 件 ·
aws-cloudformation/cloudformation-cli-python-plugin の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
learningequality/ricecooker#747 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
run-llama/llama_index#23199 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
KhronosGroup/glTF-Blender-IO#2769 ·