Improve docstrings for Hooks
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Empieza por localizar las interfaces públicas de Hook, incluido HookContext, en el paquete cloudformation_cli_python_lib; después, compáralas con el ejemplo generado ../handlers.py y con la documentación Implement Hook handlers (Python). Revisa cómo se exponen request.hookContext y targetModel. Se considera terminado cuando las clases y propiedades públicas relevantes tienen docstrings de Python útiles que explican su significado y los valores esperados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Python
- Estrellas
- 107
- Forks
- 46
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de aws-cloudformation/cloudformation-cli-python-plugin
-
Support UV Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Repo alive? Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
aws-cloudformation/cloudformation-cli-python-plugin#270 · 1 comentario · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
aws-cloudformation/cloudformation-cli-python-plugin#268 · 1 comentario · 2 reacciones ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
aws-cloudformation/cloudformation-cli-python-plugin#264 · 1 comentario ·
-
Support newer version of Python Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
aws-cloudformation/cloudformation-cli-python-plugin#263 · 2 comentarios · 3 reacciones ·
Todos los issues de aws-cloudformation/cloudformation-cli-python-plugin
Issues similares
-
Add: hunch Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
DiamondLightSource/dodal#2211 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
openml/openml-python#1749 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
sipyourdrink-ltd/bernstein#6191 ·