MattIPv4 / MattIPv4/PyDMXControl
[Python] Implement docstrings and testing
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 143
- Forks
- 23
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
L’issue ne mentionne aucun fichier, test ou point d’entrée. Commencez par examiner la bibliothèque Python afin de définir le périmètre des docstrings et des tests de régression ; le travail est terminé lorsque le code est documenté et que des tests pertinents protègent les méthodes existantes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation, testing
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 20/100