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.

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

bpo-33859: Fix spelling mistakes in docs #7691

Merged
merged 3 commits into from
Jun 16, 2018

Conversation

tirkarthi
Copy link
Member

@tirkarthi tirkarthi commented Jun 14, 2018

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 (Reverted)
  • 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 (Reverted)
  • 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 and manual search

tr '[:upper:]' '[:lower:]' < typos.txt | sort | uniq | less

This requires manually looking at output of less and then making changes.

https://bugs.python.org/issue33859

@tirkarthi tirkarthi requested a review from a team as a code owner June 14, 2018 12:12
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

When your account is ready, please add a comment in this pull request
and a Python core developer will remove the CLA not signed label
to make the bot check again.

Thanks again for your contribution, we look forward to reviewing it!

@tirkarthi
Copy link
Member Author

I have signed the CLA with bugs.python.org

username: xtreak

@tirkarthi
Copy link
Member Author

Please add "skip news" label since they are typo fixes and I think it's not necessary. Kindly correct me if I am wrong since I am a first time contributor.

Thanks

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @tirkarthi, Thanks for your first contribution. I recommend leaving the cypher as is in codecs.rst.

@@ -1389,7 +1389,7 @@ mapping. It is not supported by :meth:`str.encode` (which only produces
+--------------------+---------+---------------------------+
| Codec | Aliases | Purpose |
+====================+=========+===========================+
| rot_13 | rot13 | Returns the Caesar-cypher |
| rot_13 | rot13 | Returns the Caesar-cipher |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's leave this unchanged since cypher is a valid word.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I took reference from https://en.m.wikipedia.org/wiki/Caesar_cipher and I think I couldn't find Cypher across the docs making the change. I will revert it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@willingc kindly confirm if the change needs to be reverted given the above link.

Thanks

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tirkarthi Both are used interchangeably in the literature. I would leave the original author's spelling. Thanks.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@willingc Sure. Reverted to cypher. Thanks.

Doc/license.rst Outdated
@@ -703,7 +703,7 @@ of the OpenSSL license here::
* The implementation was written so as to conform with Netscapes SSL.
*
* This library is free for commercial and non-commercial use as long as
* the following conditions are aheared to. The following conditions
* the following conditions are adhered to. The following conditions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need a special authorization from PSF lawyers for changing the text of the license.

I suggest to leave this text as is.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted it back. Thanks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch @serhiy-storchaka. I missed the license as we typically have in all caps on Jupyter stuff.

@terryjreedy
Copy link
Member

There is an ???@python.org email for legal issues. It should be in the license or somewhere on python.org. Sending an email about the license type might get it fixed.

What's New in 3.7 does not exist in 3.6 and should block automerging to 3.6. I personally would put it in a separate PR for this issue only backported to 3.7. Or you can manually do the 3.6 backport.

@terryjreedy
Copy link
Member

For this issue, it may be that some of the misspellings were introduced in 3.7 or 3.8, so that backports will fail anyway. (I am speculating this because there was a general fix-typos issue just a few months ago.) An alternative to manual backports would be to runs the checks on 3.6 and 3.7 as well as 3.8.

@tirkarthi
Copy link
Member Author

tirkarthi commented Jun 15, 2018

@terryjreedy Thanks for the feedback. Sorry, I am a little confused since I am a beginner. I suppose there is a bot named @miss-islington that would try them and is there a way to manually trigger it to see if the backports fail? With respect to backporting can you please point me to docs so that I can learn more about this. It will be helpful if you can give me source branches for these so that I can try making separate PRs by running checks on them to see if the spellings are fixed and keep this one to master as such.

It will be helpful to know merge timelines for this PR and others like 3.7 since 3.8 alpha is the latest one with 3.7 in RC phase. I will try these over the weekend.

Thanks.

@tirkarthi
Copy link
Member Author

I think cherry-picker.py will handle the branches but needs this PR to be merged so that I can use the squashed commit. I think I can wait for this to be merged. I am open to inputs on this.

Thanks

@serhiy-storchaka
Copy link
Member

In any case we should merge a PR into the master branch first than create backporting PRs.

@serhiy-storchaka serhiy-storchaka merged commit c151f78 into python:master Jun 16, 2018
@miss-islington
Copy link
Contributor

Thanks @tirkarthi for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-7748 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 16, 2018
(cherry picked from commit c151f78)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
@miss-islington
Copy link
Contributor

Sorry, @tirkarthi and @serhiy-storchaka, I could not cleanly backport this to 3.6 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker c151f7846d6d900c22edaaa77f5f7771b529099e 3.6

@serhiy-storchaka
Copy link
Member

serhiy-storchaka commented Jun 16, 2018

As you can see, the @miss-islington bot successfully created a backport for 3.7, but failed to create a backport to 3.6 because of changes to Doc/whatsnew/3.7.rst. She/it has left a suggestion for manual backporting.

@tirkarthi
Copy link
Member Author

@serhiy-storchaka Thanks, I will raise a separate PR as a manual backport.

miss-islington added a commit that referenced this pull request Jun 16, 2018
(cherry picked from commit c151f78)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
tirkarthi added a commit to tirkarthi/cpython that referenced this pull request Jun 16, 2018
(cherry picked from commit c151f78)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
@bedevere-bot
Copy link

GH-7750 is a backport of this pull request to the 3.6 branch.

serhiy-storchaka pushed a commit that referenced this pull request Jun 16, 2018
(cherry picked from commit c151f78)

Co-authored-by: Xtreak <tirkarthi@users.noreply.github.com>
@serhiy-storchaka serhiy-storchaka removed their assignment Oct 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants