apache / apache/arrow

[CI][Dev][Python] Validate Cython docstrings with pre-commit + numpydoc

Aperta
#46,641 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Component: Continuous Integration Component: Developer Tools Component: Python Type: enhancement
Lingua principale
C++
Stelle
17.1k
Fork
4.3k
Merge medio
3g 18h
PR unite (30g)
91

Descrizione

### Describe the enhancement requested

We want to implement Cython support in numpydoc (upstream) not Archery for easy to maintain: https://github.com/apache/arrow/blob/b8c9f763fe0d94287b27b1478f169ba569c065d9/dev/archery/archery/lang/python.py#L164-L175

The Cython integration was implemented by https://github.com/apache/arrow/pull/12698 .

See also: https://github.com/apache/arrow/pull/46595#issuecomment-2915432875

### Component(s)

Continuous Integration, Developer Tools, Python

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da dev/archery/archery/lang/python.py intorno alle righe 164-175, quindi esamina Apache Arrow PR 12698 e il supporto upstream di numpydoc a cui si fa riferimento nell’issue. Conferma il flusso esistente di pre-commit e CI e usa la discussione di PR 46595 come contesto. Il lavoro è completato quando le docstring Cython vengono validate tramite pre-commit, con il supporto mantenuto upstream anziché in Archery.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
ci-cd, tooling
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.