alteryx / alteryx/evalml

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

Abierto
#207 3 comentarios 0 reacciones 1 asignado Reclamado por @asniyaz Ver en GitHub
documentation good first issue spike
Lenguaje dominante
Python
Estrellas
850
Forks
96
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.