UCL-ARC / UCL-ARC/python-tooling
Enforce a docstring style (or allow users to set)
Abierto
Nadie ha tomado este issue todavía.
documentation
enhancement
p4-low
task
- Lenguaje dominante
- Python
- Estrellas
- 62
- Forks
- 10
- Merge medio
- 7 d 6 h
- PR fusionados (30 d)
- 6
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 35/100