Corriger les fautes d'orthographe courantes dans le code et la documentation avant les revues avec codespell
Effectuez un passage rapide de vérification typographique sur les fichiers source et la documentation afin que les fautes d'orthographe courantes soient corrigées avant de se propager dans les revues et les versions.
Prérequis
Python 3.9+ et l'interface en ligne de commande codespell dans un dépôt ou une arborescence de documentation extraite.
Installation
Utilisez la méthode d'installation officielle ou celle qui correspond à votre environnement :
- Vous pouvez utiliser pip pour installer codespell, par exemple :
- pip install codespell
- pip install --upgrade pip setuptools setuptools_scm wheel
- pip install -e ".[dev]"
Exigences et mises en garde de la source officielle :
- Python 3.9 ou supérieur.
- Lorsque vous ignorez des faux positifs, notez que les erreurs d'orthographe sont insensibles à la casse mais que les mots à ignorer sont sensibles à la casse. Par exemple, l'entrée de dictionnaire wrod correspondra également à la faute de frappe Wrod, mais pour l'ignorer, vous devez...
- Certaines situations peuvent nécessiter d'ignorer un mot spécifique à un endroit précis. Cela peut être obtenu en ajoutant un commentaire dans le code source.
Notes de base ou de démarrage :
- .. code-block:: sh
- Source : https://github.com/codespell-project/codespell
- Extrait de la documentation officielle : https://raw.githubusercontent.com/codespell-project/codespell/HEAD/README.rst