rapidsai/cudf

Enable numpydoc validation

Open

#11 253 ouverte le 12 juil. 2022

Voir sur GitHub
 (25 commentaires) (0 réactions) (0 assignés)C++ (735 forks)batch import
0 - BacklogPythondocgood first issue

Métriques du dépôt

Stars
 (6 000 stars)
Métriques de merge PR
 (Merge moyen 17j 21h) (230 PRs mergées en 30 j)

Description

numpydoc supports docstring validation that we should enable to supplement things like pydocstyle checks. The numpydoc validation will help us with more semantic checking, such as ensuring that docstrings actually align with the function signatures that they are attached to.

Guide contributeur

Direction de recherche
Examinez les commentaires de l'issue pour toute discussion antérieure sur les détails d'implémentation et les pièges potentiels. Étudiez la configuration de validation de documentation existante du projet dans les fichiers de configuration CI (par exemple, .github/workflows, setup.cfg) pour comprendre comment intégrer la validation numpydoc. La documentation de numpydoc fournit des conseils pour activer la validation. Les fonctions spécifiques à valider sont les fonctions Python dans cuDF.
Stack technique
python
Domaine
documentationdeveloper experience
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75