Improve docstrings for Hooks
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 45/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
先在 cloudformation_cli_python_lib 套件中找出包括 HookContext 在內的公開 Hook 介面，接著將其與產生的 ../handlers.py 範例和 Implement Hook handlers (Python) 文件進行比較。檢視 request.hookContext 和 targetModel 如何公開。相關的公開類別和屬性具有實用的 Python 文件字串，能夠說明其意義和預期值，即表示完成。
由索引模型根據 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
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
aws-cloudformation/cloudformation-cli-python-plugin 的其他 Issue
-
Support UV未關閉
難度 2/5 1-3 小時 新手友好度 78/100
-
Repo alive?未關閉
難度 5/5 一週以上 新手友好度 20/100
aws-cloudformation/cloudformation-cli-python-plugin#270 · 1 則留言 · 1 個 reaction ·
-
難度 3/5 1-2 天 新手友好度 35/100
aws-cloudformation/cloudformation-cli-python-plugin#268 · 1 則留言 · 2 個 reaction ·
-
難度 3/5 1-2 天 新手友好度 35/100
aws-cloudformation/cloudformation-cli-python-plugin#264 · 1 則留言 ·
-
難度 5/5 一週以上 新手友好度 25/100
aws-cloudformation/cloudformation-cli-python-plugin#263 · 2 則留言 · 3 個 reaction ·
查看 aws-cloudformation/cloudformation-cli-python-plugin 的全部 Issue
相似的 Issue
-
upstream update
難度 2/5 1-3 小時 新手友好度 75/100
conan-io/conan-center-index#31098 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
john-kurkowski/tldextract#382 ·
-
comp/tools duplicate P2 sweeper:risk-compatibility tool/mcp type/bug
難度 1/5 1 小時以內 新手友好度 88/100
NousResearch/hermes-agent#132042 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
deepset-ai/haystack#13092 ·
維護者通常 1 天內回覆
-
難度 1/5 1-3 小時 新手友好度 85/100
feder-cr/invisible_playwright_mcp#1408 ·
維護者通常 1 天內回覆