alteryx/evalml

Audit: write up where we need to add docstring runnable examples

Ouverte

#207 ouverte le 12 nov. 2019

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (1 personne assignée)Python (93 forks)auto 404
documentationgood first issuespike

Métriques du dépôt

Stars
 (852 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

We should add examples to the doc strings of as many functions as possible.

We can also set these up as doctests, so that when we build the docs, the output of the method call is tested against the example.

We do this in featuretools. For example: https://docs.featuretools.com/en/stable/generated/featuretools.primitives.Count.html#featuretools.primitives.Count

Guide contributeur

Direction de recherche
Identifiez les fonctions sans exemples de docstring en auditant la base de code. Suivez le modèle de featuretools : ajoutez des exemples exécutables dans les docstrings et configurez les comme doctests. Exécutez les tests pour vous assurer que les exemples passent.
Stack technique
python
Domaine
documentationtesting
Type d'issue
Documentation
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75