alteryx / alteryx/evalml

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

Open
#207 3 comments 0 reactions 1 assignee Claimed by @asniyaz View on GitHub
documentation good first issue spike
Dominant language
Python
Stars
850
Forks
96
PR merge metrics
No merged PRs in 30d

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.