apache / apache/arrow

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

Offen
#46,641 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Component: Continuous Integration Component: Developer Tools Component: Python Type: enhancement
Vorherrschende Sprache
C++
Sterne
17.1k
Forks
4.3k
Ø Merge
3 T. 23 Std.
Gemergte PRs (30 T.)
101

Beschreibung

### 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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit dev/archery/archery/lang/python.py in der Nähe der Zeilen 164–175 und prüfe anschließend Apache Arrow PR 12698 sowie die im Issue referenzierte numpydoc-Unterstützung upstream. Bestätige den bestehenden pre-commit- und CI-Ablauf und nutze die Diskussion zu PR 46595 als Kontext. Erledigt ist die Aufgabe, wenn Cython-Dokumentstrings durch pre-commit validiert werden und die Unterstützung upstream statt in Archery gepflegt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
ci-cd, tooling
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.