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
贡献指南
从这里开始
- 先读完整个 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
-
enhancement
难度 2/5 1-3 小时 新手友好度 70/100
canonical/paas-charm#368 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
tech debt
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 1/5 1 小时以内 新手友好度 90/100
StevenBlack/hosts#3256 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
qualcomm/qai-appbuilder#275 ·