alteryx / alteryx/evalml

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

オープン
#207 コメント 3 件 リアクション 0 件 担当者 1 名 @asniyaz が担当を希望しています GitHub で見る
documentation good first issue spike
主要言語
Python
スター
850
フォーク
96
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。