Improve docstrings for Hooks
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by locating the public hook interfaces, including HookContext, in the cloudformation_cli_python_lib package, then compare them with the generated ../handlers.py example and the Implement Hook handlers (Python) documentation. Review how request.hookContext and targetModel are exposed. Done means the relevant public classes and properties have useful Python docstrings that explain their meaning and expected values.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- Python
- Stars
- 107
- Forks
- 46
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aws-cloudformation/cloudformation-cli-python-plugin
-
Support UV Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Repo alive? Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
aws-cloudformation/cloudformation-cli-python-plugin#270 · 1 comment · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
aws-cloudformation/cloudformation-cli-python-plugin#268 · 1 comment · 2 reactions ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
aws-cloudformation/cloudformation-cli-python-plugin#264 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
aws-cloudformation/cloudformation-cli-python-plugin#263 · 2 comments · 3 reactions ·
All issues in aws-cloudformation/cloudformation-cli-python-plugin
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
use-agent-os/agent-os#3314 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
AiursoftWeb/AnduinOS-2#19 ·