alteryx/evalml

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

オープン

#207 opened on 2019/11/12

 (3 件のコメント) (0 件のリアクション) (1 人の担当者)Python (93 件のフォーク)auto 404
documentationgood first issuespike

Repository metrics

Stars
 (852 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド