UCL-ARC / UCL-ARC/python-tooling
Enforce a docstring style (or allow users to set)
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 62
- Fork
- 10
- Merge medio
- 7g 6h
- PR unite (30g)
- 6
Descrizione
We can enforce this with https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings. Let's make an issue for that.
Originally posted by @paddyroddy in https://github.com/UCL-ARC/python-tooling/pull/566#discussion_r2215495808
Guida per i contributori
Apri la 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.
Direzione di ricerca
Start with the Ruff FAQ section linked in the issue, then inspect how this Python template configures Ruff and docstrings. Clarify whether the template should enforce one style or expose a user setting, and consider the work done when that behavior is consistently configured for generated projects.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100