alteryx/evalml

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

Open

#207 opened on Nov 12, 2019

View on GitHubContributor guide
 (3 comments) (0 reactions) (1 assignee)Python (93 forks)auto 404
documentationgood first issuespike

Repository metrics

Stars
 (852 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Identify functions without docstring examples by auditing the codebase. Follow the pattern in featuretools: add runnable examples in docstrings and set up as doctests. Run tests to ensure examples pass.
Tech stack
python
Domain
documentationtesting
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75