[issue33859] Spelling mistakes found using aspell
New submission from Karthikeyan Singaravelan <tir.karthi@gmail.com>: I have found some typos in docs folder using aspell. I have fixed them. The changes are as below : Doc/library/codecs.rst - cypher - cipher Doc/library/email.rst - Protcol - Protocol Doc/library/importlib.rst - abstact - abstract Doc/library/xmlrpc.client.rst - unmarsalling - unmarshalling Doc/license.rst - aheared to - adhered to Doc/using/cmdline.rst - descibed - described Doc/whatsnew/3.3.rst - accumlated - accumulated Doc/whatsnew/3.6.rst - Lollilop - Lollipop Doc/whatsnew/3.7.rst - direcory - directory Find typos - find . -iname '*rst' | xargs -I{} sh -c "aspell --master=en_US --extra-dicts=en_GB --ignore 3 list < {}" | sort | uniq > typos.txt Ignore case tr '[:upper:]' '[:lower:]' < typos.txt | sort | uniq | less This requires manually looking at output of less and then making changes. ---------- assignee: docs@python components: Documentation messages: 319510 nosy: docs@python, xtreak priority: normal severity: normal status: open title: Spelling mistakes found using aspell type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
Change by Karthikeyan Singaravelan <tir.karthi@gmail.com>: ---------- keywords: +patch pull_requests: +7304 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
Serhiy Storchaka <storchaka+cpython@gmail.com> added the comment: New changeset c151f7846d6d900c22edaaa77f5f7771b529099e by Serhiy Storchaka (Xtreak) in branch 'master': bpo-33859: Fix spelling mistakes in docs. (GH-7691) https://github.com/python/cpython/commit/c151f7846d6d900c22edaaa77f5f7771b52... ---------- nosy: +serhiy.storchaka _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +7356 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 416e488415cacec98778da11da401c1b94d92c10 by Miss Islington (bot) in branch '3.7': bpo-33859: Fix spelling mistakes in docs. (GH-7691) https://github.com/python/cpython/commit/416e488415cacec98778da11da401c1b94d... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
Change by Karthikeyan Singaravelan <tir.karthi@gmail.com>: ---------- pull_requests: +7358 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
Serhiy Storchaka <storchaka+cpython@gmail.com> added the comment: New changeset c5ff553ae717c33f86d4fa984ee92de71c467f2a by Serhiy Storchaka (Xtreak) in branch '3.6': [3.6] bpo-33859: Fix spelling mistakes in docs. (GH-7691). (GH-7750) https://github.com/python/cpython/commit/c5ff553ae717c33f86d4fa984ee92de71c4... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
Raymond Hettinger <raymond.hettinger@gmail.com> added the comment: Thanks for finding these mistakes :-) ---------- nosy: +rhettinger _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
Karthikeyan Singaravelan <tir.karthi@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/a5c9f1f9fbcda0a6e16ea80e64452b33006f4... 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@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
Karthikeyan Singaravelan <tir.karthi@gmail.com> added the comment: Closing this since the related PRs are merged. ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________
participants (4)
-
Karthikeyan Singaravelan -
miss-islington
-
Raymond Hettinger
-
Serhiy Storchaka