코드와 문서의 일반적인 오타를 리뷰 혼란 전에 codespell로 잡아내기
소스 파일과 문서에 빠른 오타 검사를 실행하여 일반적인 오타가 리뷰와 릴리스를 통해 퍼지기 전에 수정합니다.
전제 조건
Python 3.9+와 체크아웃된 저장소 또는 문서 트리 내 codespell CLI가 필요합니다.
설치
환경에 맞는 upstream 설치 또는 설정 경로를 사용하세요:
- pip를 사용하여 codespell을 설치할 수 있습니다. 예:
- pip install codespell
- pip install --upgrade pip setuptools setuptools_scm wheel
- pip install -e ".[dev]"
upstream의 요구 사항 및 주의 사항:
- Python 3.9 이상.
- 거짓 양성을 무시할 때 철자 오류는 대소문자 구분 없이 일치하지만 무시할 단어는 대소문자 구분이 있습니다. 예를 들어, 사전 항목 wrod는 오타 Wrod와도 일치하지만, 무시하려면 반드시...
- 특정 상황에서는 특정 위치에 있는 특정 단어를 무시해야 할 수 있습니다. 이는 소스 코드에 주석을 추가하여 달성할 수 있습니다.
기본 사용법 또는 시작하기 노트:
- .. code-block:: sh
- 출처: https://github.com/codespell-project/codespell
- upstream 문서에서 발췌: https://raw.githubusercontent.com/codespell-project/codespell/HEAD/README.rst