Corregir errores tipográficos comunes en código y documentación antes de la revisión con codespell
Realiza una pasada rápida de corrección tipográfica en archivos fuente y documentación para que los errores comunes se corrijan antes de que se propaguen en revisiones y lanzamientos.
Prerrequisitos
Python 3.9+ y la CLI de codespell en un repositorio clonado o árbol de documentación.
Instalación
Usa la ruta de instalación oficial o la configuración que coincida con tu entorno:
- Puedes usar pip para instalar codespell, por ejemplo:
- pip install codespell
- pip install --upgrade pip setuptools setuptools_scm wheel
- pip install -e ".[dev]"
Requisitos y advertencias del proyecto upstream:
- Python 3.9 o superior.
- Al ignorar falsos positivos, ten en cuenta que los errores ortográficos son insensibles a mayúsculas/minúsculas pero las palabras a ignorar son sensibles a mayúsculas/minúsculas. Por ejemplo, la entrada del diccionario
wrodtambién coincidirá con el error tipográficoWrod, pero para ignorarlo debes... - Algunas situaciones pueden requerir ignorar una palabra específica en una ubicación concreta. Esto se puede lograr añadiendo un comentario en el código fuente.
Notas de uso básico o introducción:
- .. code-block:: sh
- Fuente: https://github.com/codespell-project/codespell
- Extraído de la documentación upstream: https://raw.githubusercontent.com/codespell-project/codespell/HEAD/README.rst