alteryx/evalml

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

Offen

#207 geöffnet am 12.11.2019

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (93 Forks)auto 404
documentationgood first issuespike

Repository-Metriken

Stars
 (852 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

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

Contributor Guide

Research-Richtung
Identifizieren Sie Funktionen ohne Docstring Beispiele, indem Sie die Codebasis prüfen. Folgen Sie dem Muster in featuretools: Fügen Sie ausführbare Beispiele in Docstrings hinzu und richten Sie sie als Doctests ein. Führen Sie Tests aus, um sicherzustellen, dass die Beispiele bestehen.
Tech Stack
python
Domain
documentationtesting
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75