Audit: write up where we need to add docstring runnable examples
Offen
documentation
good first issue
spike
- Vorherrschende Sprache
- Python
- Sterne
- 850
- Forks
- 96
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Bewertung
Dieses Issue wurde noch nicht bewertet.