Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docstrings for Hooks #269

Open
neilramsay opened this issue Mar 6, 2024 · 0 comments
Open

Improve docstrings for Hooks #269

neilramsay opened this issue Mar 6, 2024 · 0 comments

Comments

@neilramsay
Copy link

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:
image

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:
image

Cheers,
Neil

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant