Skip to content

Improve docstrings for Hooks #269

Open
@neilramsay

Description

@neilramsay

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions