MattIPv4 / MattIPv4/PyDMXControl
[Python] Implement docstrings and testing
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 143
- Forks
- 23
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
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
Das Issue nennt keine Dateien, Tests oder Einstiegspunkte. Beginne mit einer Untersuchung der Python-Bibliothek, um den Umfang für docstrings und Regressionstests festzulegen; als abgeschlossen gilt die Aufgabe, wenn der Code dokumentiert ist und aussagekräftige Tests vorhanden sind, die bestehende Methoden schützen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation, testing
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100