aws-cloudformation / aws-cloudformation/cloudformation-cli-python-plugin

Improve docstrings for Hooks

Open
#269 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
107
Forks
46
PR merge metrics
No merged PRs in 30d

Description

Hi there :wave:,

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:
![image](https://github.com/aws-cloudformation/cloudformation-cli-python-plugin/assets/2934552/9f35d4e1-a9bf-4ffd-840a-1b4dcef4a5bf)

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)](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-model.html#model-hook-project-code-handler-python) documentation.

In the case of `HookContext` some docstrings like this would be welcome:
![image](https://github.com/aws-cloudformation/cloudformation-cli-python-plugin/assets/2934552/4aaa6841-b274-4c36-9f1b-07d5b84f6770)

Cheers,
Neil

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.