evalml icon indicating copy to clipboard operation
evalml copied to clipboard

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

Open kmax12 opened this issue 5 years ago • 3 comments

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

kmax12 avatar Nov 12 '19 23:11 kmax12

@dsherry to write list of missing methods

kmax12 avatar Dec 09 '19 17:12 kmax12

I think this is interesting, but I'm converting it into a spike because there's no clear left and right limits on what will close this issue. I think if we have it generate an epic, that might be good, though.

chukarsten avatar Feb 11 '21 15:02 chukarsten

Yep, let's have the outcome of this issue be a list of the highest-importance places we should have docstring examples. IMO the automl search and pipeline APIs are at the top of that list. Things like AutoMLAlgorithm are lower priority because they're internal.

Then once we have that list we can file issues for specific parts, as good first issues, and pick em off.

dsherry avatar Feb 11 '21 17:02 dsherry