Improve the docstring of abstract.CloudEvent

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

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
48/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
documentation

Piste de recherche

Ouvrez cloudevents/abstract/event.py autour des lignes 99-100 et examinez la docstring de getitem. Lisez l’issue #246 pour comprendre la confusion signalée concernant l’accès aux données privées de _attributes. C’est terminé lorsque la docstring explique pourquoi event.get() est déconseillé et inclut un exemple utile ou une référence.

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

Description

The getitem of this class goes on to describe that:

https://github.com/cloudevents/sdk-python/blob/c5645d8fcf03432639727b9a7f6508c3059a1673/cloudevents/abstract/event.py#L99-L100

providing a reason and perhaps a reference to an example would help developers understand why event.get() is discouraged by this helper method.

For instance, there is confusion in how the private _attributes data should be accessed expressed in https://github.com/cloudevents/sdk-python/issues/246.

Langage dominant
Python
Étoiles
342
Forks
65
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 cloudevents/sdk-python

Toutes les issues de cloudevents/sdk-python

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.