tukaani-project / xz

XZ Utils
https://tukaani.org/xz/
Other
532 stars 95 forks source link

Fix typos found by codespell #58

Closed DimitriPapadopoulos closed 1 year ago

DimitriPapadopoulos commented 1 year ago

Pull request checklist

Please check if your PR fulfills the following requirements:

Pull request type

Please check the type of change your PR introduces: - [ ] Bugfix - [ ] Feature - [ ] Code style update (formatting, renaming, typo fix) - [ ] Refactoring (no functional changes, no api changes) - [ ] Build related changes - [x] Documentation content changes - [ ] Other (please describe): ## What is the current behavior? Typos. ## What is the new behavior? Fixed typos. ## Does this introduce a breaking change? - [ ] Yes - [x] No

Other information

JiaT75 commented 1 year ago

Thanks for the typo fixes! Maybe we should include codespell as part of the CI pipeline or a local git hook. Or even a manual step for myself before pushing...

DimitriPapadopoulos commented 1 year ago

You're welcome. A manual step might be preferable to start with, as there are often false positives, and of course false negatives. You can install codespell using pip install codespell and run it locally. Create a .codespellrc file if you need specific configuration.

Once you are accustomed to it, you may try the GitHub action.