[docs] [issue33859] Spelling mistakes found using aspell

Karthikeyan Singaravelan report at bugs.python.org
Sat Jun 16 03:06:20 EDT 2018

Karthikeyan Singaravelan <tir.karthi at gmail.com> added the comment:

Thanks much @rhettinger and the team for all the work on documentation. This is my first patch and I am pretty amazed at the smooth experience for a beginner like me with GitHub and helpful bots. I hope to contribute more.

Just wanted to leave a note that this was inspired by the Rust book's work where they have a CI running with aspell to make sure that there are no spelling mistakes in the book. It would require a personal dictionary where all the valid words have to be added. I think given the rate of documentation changes that go into the repository having a personal dictionary will result in merge conflicts and not a feasible option but I just want to put this idea here. The initial work requires me to a manual scan of 10k words and hence I might have missed some words or assumed some spellings as correct. I think this can be used for code comments as well but would require even more attention since the dictionary file will be large.

Reference : https://github.com/rust-lang/book/blob/a5c9f1f9fbcda0a6e16ea80e64452b33006f4127/ci/spellcheck.sh#L56

Command to generate a personal file : 

cd Docs && find . -iname '*rst' | xargs -I{} sh -c "aspell --master=en_US --extra-dicts=en_GB --ignore 3 list < {}" | sort | uniq > typos.txt

typos.txt : https://gist.github.com/tirkarthi/d49ac3fdce93c1e3ab4b85b5e1c82b49

Thanks again :)


Python tracker <report at bugs.python.org>

More information about the docs mailing list