alteryx/evalml

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

Aperta

#207 aperta il 12 nov 2019

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (1 assegnatario)Python (93 fork)auto 404
documentationgood first issuespike

Metriche repository

Star
 (852 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Identifica le funzioni prive di esempi nei docstring controllando il codice. Segui il pattern di featuretools: aggiungi esempi eseguibili nei docstring e configurali come doctest. Esegui i test per verificare che gli esempi funzionino.
Tech stack
python
Dominio
documentationtesting
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75