cloudevents / cloudevents/sdk-python
Improve the docstring of abstract.CloudEvent
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 342
- Forks
- 65
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
The getitem of this class goes on to describe that:
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Öffne cloudevents/abstract/event.py im Bereich um die Zeilen 99–100 und prüfe den getitem-Docstring. Lies Issue #246, um die gemeldete Verwirrung beim Zugriff auf private _attributes-Daten zu verstehen. Erledigt ist die Aufgabe, wenn der Docstring erklärt, warum event.get() nicht empfohlen wird, und ein nützliches Beispiel oder einen Verweis enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100