rapidsai/cudf

Enable numpydoc validation

Open

#11.253 geöffnet am 12. Juli 2022

Auf GitHub ansehen
 (25 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (735 Forks)batch import
0 - BacklogPythondocgood first issue

Repository-Metriken

Stars
 (6.000 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 17T 21h) (230 gemergte PRs in 30 T)

Beschreibung

numpydoc supports docstring validation that we should enable to supplement things like pydocstyle checks. The numpydoc validation will help us with more semantic checking, such as ensuring that docstrings actually align with the function signatures that they are attached to.

Contributor Guide

Research-Richtung
Überprüfe die Issue Kommentare auf frühere Diskussionen zu Implementierungsdetails und potenziellen Fallstricken. Untersuche die vorhandene Dokumentationsvalidierungskonfiguration des Projekts in CI Konfigurationsdateien (z. B. .github/workflows, setup.cfg), um zu verstehen, wie die numpydoc Validierung integriert werden kann. Die numpydoc Dokumentation bietet Anleitungen zur Aktivierung der Validierung. Die spezifischen zu validierenden Funktionen sind Python Funktionen in cuDF.
Tech Stack
python
Domain
documentationdeveloper experience
Issue Type
Wartung
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
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75