DiamondLightSource / DiamondLightSource/python-copier-template
Support linting docstrings
Aperta
- Lingua principale
- Jinja
- Stelle
- 25
- Fork
- 10
- Merge medio
- 4h 4m
- PR unite (30g)
- 6
Descrizione
https://github.com/jsh9/pydoclint , https://github.com/akaihola/darglint2 and others lint docstrings to ensure they are congruent with the function/class/method that they are documenting. This could be a useful sanity check
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
No file or test is named. Start by inspecting how the template configures Python linting and dependencies, then compare pydoclint and darglint2 for compatibility with that setup. Done should include a decided tool, an integrated configuration, and validation that docstring consistency checks run as intended.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 38/100