rapidsai/cudf

Enable numpydoc validation

Open

#11.253 aperta il 12 lug 2022

Vedi su GitHub
 (25 commenti) (0 reazioni) (0 assegnatari)C++ (735 fork)batch import
0 - BacklogPythondocgood first issue

Metriche repository

Star
 (6000 star)
Metriche merge PR
 (Merge medio 17g 21h) (230 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi i commenti dell'issue per eventuali discussioni precedenti sui dettagli di implementazione e le potenziali insidie. Esamina la configurazione di validazione della documentazione esistente del progetto nei file di configurazione CI (ad es. .github/workflows, setup.cfg) per capire come integrare la validazione numpydoc. La documentazione di numpydoc fornisce indicazioni su come abilitare la validazione. Le funzioni specifiche da validare sono le funzioni Python in cuDF.
Tech stack
python
Dominio
documentationdeveloper experience
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75