Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Spelling mistakes found using aspell #78040

Closed
tirkarthi opened this issue Jun 14, 2018 · 7 comments
Closed

Spelling mistakes found using aspell #78040

tirkarthi opened this issue Jun 14, 2018 · 7 comments
Labels
3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@tirkarthi
Copy link
Member

BPO 33859
Nosy @rhettinger, @serhiy-storchaka, @miss-islington, @tirkarthi
PRs
  • bpo-33859: Fix spelling mistakes in docs #7691
  • [3.7] bpo-33859: Fix spelling mistakes in docs. (GH-7691) #7748
  • [3.6] bpo-33859: Fix spelling mistakes in docs. (GH-7691). #7750
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2018-07-13.09:51:19.719>
created_at = <Date 2018-06-14.12:09:39.852>
labels = ['type-feature', '3.8', 'docs']
title = 'Spelling mistakes found using aspell'
updated_at = <Date 2018-07-13.09:51:19.717>
user = 'https://github.com/tirkarthi'

    bugs.python.org fields:

    activity = <Date 2018-07-13.09:51:19.717>
actor = 'xtreak'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-07-13.09:51:19.719>
closer = 'xtreak'
components = ['Documentation']
creation = <Date 2018-06-14.12:09:39.852>
creator = 'xtreak'
dependencies = []
files = []
hgrepos = []
issue_num = 33859
keywords = ['patch']
message_count = 7.0
messages = ['319510', '319715', '319718', '319720', '319721', '319722', '321587']
nosy_count = 5.0
nosy_names = ['rhettinger', 'docs@python', 'serhiy.storchaka', 'miss-islington', 'xtreak']
pr_nums = ['7691', '7748', '7750']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33859'
versions = ['Python 3.8']
    @tirkarthi
    Copy link
    Member Author

    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.

    @tirkarthi tirkarthi added the 3.8 only security fixes label Jun 14, 2018
    @tirkarthi tirkarthi added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Jun 14, 2018
    @serhiy-storchaka
    Copy link
    Member

    New changeset c151f78 by Serhiy Storchaka (Xtreak) in branch 'master':
    bpo-33859: Fix spelling mistakes in docs. (GH-7691)
    c151f78

    @miss-islington
    Copy link
    Contributor

    New changeset 416e488 by Miss Islington (bot) in branch '3.7':
    bpo-33859: Fix spelling mistakes in docs. (GH-7691)
    416e488

    @serhiy-storchaka
    Copy link
    Member

    New changeset c5ff553 by Serhiy Storchaka (Xtreak) in branch '3.6':
    [3.6] bpo-33859: Fix spelling mistakes in docs. (GH-7691). (GH-7750)
    c5ff553

    @rhettinger
    Copy link
    Contributor

    Thanks for finding these mistakes :-)

    @tirkarthi
    Copy link
    Member Author

    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 :)

    @tirkarthi
    Copy link
    Member Author

    Closing this since the related PRs are merged.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @rhettinger @serhiy-storchaka @tirkarthi @miss-islington