Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[CI] Linting of docs

Aperta
#1,296 6 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Review the repository's CI configuration and supported Python versions first, then compare ruff and pydocstyle against the Python 3.6 compatibility constraint and the proposed Python 3.7+ environment. Done means documentation and docstrings are linted in CI without breaking supported environments, addressing the class of issue described in #716.

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

Descrizione

Currently there is no linter for doc and docstrings.

As a follow up, this should really be linted. I would advocate using ruff but theoretically that's blocked on still supporting python 3.6 (#1083).

Should work if working in an environment that's 3.7+ though.

The alternative is to use pydocstyle.

This would prevent issues like #716 from appearing. (which I guess can be closed now?)

Lingua principale
Python
Stelle
361
Fork
296
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openml/openml-python

Tutte le issue di openml/openml-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.