Corrigir erros de ortografia comuns em código e documentação antes da revisão com codespell
Execute uma verificação rápida de erros de digitação em arquivos de código e documentação para que erros comuns sejam corrigidos antes de se espalharem por revisões e versões.
Pré-requisitos
Python 3.9+ e a CLI codespell em um repositório ou árvore de documentação verificado.
Instalação
Use o método de instalação oficial ou a configuração que corresponda ao seu ambiente:
- Você pode usar pip para instalar o codespell, por exemplo:
pip install codespellpip install --upgrade pip setuptools setuptools_scm wheelpip install -e ".[dev]"
Requisitos e observações da documentação oficial:
- Python 3.9 ou superior.
- Ao ignorar falsos positivos, observe que os erros de ortografia são insensíveis a maiúsculas/minúsculas (case-insensitive), mas as palavras a ignorar são sensíveis a maiúsculas/minúsculas (case-sensitive). Por exemplo, a entrada do dicionário "word" também corresponderá ao erro "Word", mas para ignorá-lo você deve...
- Algumas situações podem exigir ignorar uma palavra específica em um local específico. Isso pode ser alcançado adicionando um comentário no código fonte.
Notas de uso básico ou primeiros passos:
- .. code-block:: sh
- Fonte: https://github.com/codespell-project/codespell
- Extraído da documentação oficial: https://raw.githubusercontent.com/codespell-project/codespell/HEAD/README.rst