2024-04-02 18:37:37 -03:00
|
|
|
# pydocstyle
|
|
|
|
|
|
|
|
|
|
> Comprueba estáticamente que los scripts de Python cumplen con las convenciones de documentación de Python.
|
|
|
|
|
> Más información: <https://www.pydocstyle.org/en/latest/>.
|
|
|
|
|
|
|
|
|
|
- Analiza un script de Python o todos los scripts de Python en un directorio específico:
|
|
|
|
|
|
|
|
|
|
`pydocstyle {{archivo.py|ruta/al/directorio}}`
|
|
|
|
|
|
2024-06-12 07:43:11 +02:00
|
|
|
- Muestra una explicación de cada error:
|
2024-04-02 18:37:37 -03:00
|
|
|
|
2025-03-14 09:18:28 +02:00
|
|
|
`pydocstyle {{[-e|--explain]}} {{archivo.py|ruta/al/directorio}}`
|
2024-04-02 18:37:37 -03:00
|
|
|
|
2024-06-12 07:43:11 +02:00
|
|
|
- Muestra información de depuración:
|
2024-04-02 18:37:37 -03:00
|
|
|
|
2025-03-14 09:18:28 +02:00
|
|
|
`pydocstyle {{[-d|--debug]}} {{archivo.py|ruta/al/directorio}}`
|
2024-04-02 18:37:37 -03:00
|
|
|
|
|
|
|
|
- Muestra el número total de errores:
|
|
|
|
|
|
|
|
|
|
`pydocstyle --count {{archivo.py|ruta/a/directorio}}`
|
|
|
|
|
|
|
|
|
|
- Utiliza un archivo de configuración específico:
|
|
|
|
|
|
|
|
|
|
`pydocstyle --config {{ruta/a/archivo_config}} {{archivo.py|ruta/al/directorio}}`
|
|
|
|
|
|
|
|
|
|
- Ignora uno o más errores:
|
|
|
|
|
|
|
|
|
|
`pydocstyle --ignore {{D101,D2,D107,...}} {{archivo.py|ruta/al/directorio}}`
|
|
|
|
|
|
|
|
|
|
- Busca errores de una convención específica:
|
|
|
|
|
|
|
|
|
|
`pydocstyle --convention {{pep257|numpy|google}} {{archivo.py|ruta/a/directorio}}`
|
