Improve docstrings for Hooks

Ouverte
#269 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
documentation

Piste de recherche

Commencez par localiser les interfaces publiques de Hook, notamment HookContext, dans le package cloudformation_cli_python_lib, puis comparez-les avec l’exemple généré ../handlers.py et la documentation Implement Hook handlers (Python). Examinez comment request.hookContext et targetModel sont exposés. La tâche est terminée lorsque les classes et propriétés publiques pertinentes disposent de docstrings Python utiles qui expliquent leur signification et les valeurs attendues.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Python
Étoiles
107
Forks
46
Aucune PR mergée en 30 j

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de aws-cloudformation/cloudformation-cli-python-plugin

Toutes les issues de aws-cloudformation/cloudformation-cli-python-plugin

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.