Improve the docstring of abstract.CloudEvent

Aperta
#247 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Apri cloudevents/abstract/event.py intorno alle righe 99-100 ed esamina la docstring di getitem. Leggi l’issue #246 per comprendere la confusione segnalata sull’accesso ai dati privati di _attributes. Il lavoro è completato quando la docstring spiega perché event.get() è sconsigliato e include un esempio utile o un riferimento.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
342
Fork
65
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cloudevents/sdk-python

Tutte le issue di cloudevents/sdk-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.