matrix-org / matrix-org/matrix-python-sdk
Add docstrings to all public methods
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 266
- Fork
- 118
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia da get_display_name in api.MatrixHttpApi, quindi fai l’inventario degli altri metodi pubblici dell’SDK e ispeziona i relativi chiamanti esistenti. Il lavoro è completato quando ogni metodo pubblico ha una docstring; i metodi considerati privati delegano tramite wrapper pubblici obsoleti con avvisi, e le chiamate interne all’SDK usano i nomi privati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- api, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100