[Python] Implement docstrings and testing
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 20/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation, testing
Direzione di ricerca
L’issue non indica file, test o punti di ingresso. Inizia esaminando la libreria Python per definire l’ambito dei docstring e dei test di regressione; il lavoro è completato quando il codice è documentato e sono presenti test significativi che proteggono i metodi esistenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Currently the library has a lot of code dumped throughout that has no documentation associated to explain what it does. Additionally, there is no real testing in place to ensure older methods are not broken by never changes etc.
Therefor, implementing correct docstrings throughout the code and implementing proper testing would be a good way to bring up the quality of the library.
- Lingua principale
- Python
- Stelle
- 143
- Fork
- 23
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
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.
Altre issue di MattIPv4/PyDMXControl
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
MattIPv4/PyDMXControl#60 · 2 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 30/100
MattIPv4/PyDMXControl#58 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
MattIPv4/PyDMXControl#56 · 2 commenti ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
MattIPv4/PyDMXControl#55 · 3 commenti ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 18/100
MattIPv4/PyDMXControl#52 · 5 commenti ·
Tutte le issue di MattIPv4/PyDMXControl
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
FuRongJun-1999/dsh-memory#56 ·
I maintainer di solito rispondono entro 1 giorno
-
Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
pgadmin-org/pgadmin4#10503 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
521xueweihan/HelloGitHub#3857 ·
-
needs-ac
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Ikalus1988/MisakaNet#2845 ·
I maintainer di solito rispondono entro 1 giorno
-
bug connectors operations
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
pyinfra-dev/pyinfra#1989 ·
I maintainer di solito rispondono entro 3 giorni