Add docstring linting (D-class rules) to ruff configuration
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
Direzione di ricerca
La configurazione di Ruff si trova in pyproject.toml:60; inizia esaminando la classe D ignorata e la configurazione di lint esistente. Misura le violazioni attuali delle regole D, quindi definisci le regole selezionate e le eccezioni per file; il lavoro è completato quando le regole D concordate sono abilitate senza violazioni legacy irrisolte.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Description
The project currently ignores all docstring linting rules (D-class) in the ruff configuration with a TODO comment.
Location
pyproject.toml:60
[tool.ruff.lint]
# The D (doc) and DTZ (datetime zone) lint classes current heavily violated - fix later
select = ["ALL"]
ignore = [
"D", # todo: docstring linting
# ...
]
Impact
- Inconsistent or missing docstrings across the codebase
- Reduced code maintainability and readability
- Harder for new contributors to understand code functionality
Suggested Implementation
- Start by enabling specific D-rules that are least violated (e.g., D100, D101 for missing docstrings)
- Gradually fix existing violations or use per-file ignores for legacy code
- Eventually enable all D-rules for new code
Related
Similar TODO exists for DTZ (datetime zone) rules which should also be addressed.
- Lingua principale
- Python
- Stelle
- 17
- Fork
- 50
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Nessuna guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openml/server-api
-
behavior
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
openml/server-api#337 · 1 commento ·
-
Redesign POST /data/untag for v2Forse di nuovo libera @omosola l’ha presa 39 giorni fa e non c’è nessuna pull request aperta. Apertaproposal
openml/server-api#375 · 2 commenti · 1 assegnatario ·
-
Redesign POST /data/tag for v2Forse di nuovo libera @omosola l’ha presa 39 giorni fa e non c’è nessuna pull request aperta. Aperta
openml/server-api#374 · 2 commenti · 1 assegnatario ·
-
Redesign POST /data/qualities/unprocessed/{data_engine_id}/{order} for v2Forse di nuovo libera @omosola l’ha presa 39 giorni fa e non c’è nessuna pull request aperta. Aperta
openml/server-api#373 · 1 assegnatario ·
-
Redesign POST /data/qualities for v2Forse di nuovo libera @omosola l’ha presa 39 giorni fa e non c’è nessuna pull request aperta. Aperta
openml/server-api#372 · 1 assegnatario ·
Tutte le issue di openml/server-api
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
EvaluationSuite.run fails with default args_for_task and mutates supplied kwargsForse già presa @ktz03 l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
huggingface/evaluate#825 ·
I maintainer di solito rispondono entro 1 giorno
-
dependencies feature github_actions good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
wemake-services/wemake-django-template#3149 ·
I maintainer di solito rispondono entro 1 giorno
-
[request] vsg/1.1.16Apertaupstream update
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
conan-io/conan-center-index#31142 ·
I maintainer di solito rispondono entro 1 giorno
-
area:core bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno