matrix-org / matrix-org/matrix-python-sdk
Add docstrings to all public methods
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 266
- Forks
- 118
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
For instance, get_display_name in api.MatrixHttpApi needs a docstring. Many others as well.
In doing this, you may run across methods that it seems should be private rather than public; in that case, please go ahead and make method call _method while raising a deprecation warning and point all code within the sdk towards _method
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
Beginne mit get_display_name in api.MatrixHttpApi, inventarisiere anschließend die anderen öffentlichen Methoden des SDK und untersuche deren bestehende Aufrufer. Erledigt ist die Aufgabe, wenn jede öffentliche Methode eine Docstring hat; als privat eingestufte Methoden über veraltete öffentliche Wrapper mit Warnungen delegieren und SDK-interne Aufrufe die privaten Namen verwenden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100