DiamondLightSource / DiamondLightSource/python-copier-template
Support linting docstrings
Ouverte
- Langage dominant
- Jinja
- Étoiles
- 25
- Forks
- 10
- Merge moyen
- 4 h 4 min
- PR mergées (30 j)
- 6
Description
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
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 38/100