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

Improve docstrings for Hooks

Abierto
#269 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
107
Forks
46
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.