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

Fix typos in multiple .rst files #1668

Merged
merged 17 commits into from
May 19, 2017
Merged

Fix typos in multiple .rst files #1668

merged 17 commits into from
May 19, 2017

Conversation

delirious-lettuce
Copy link
Contributor

I found a few typos while going through the .rst files of this repo. Although it's quite possible I missed some, this PR fixes the ones that I did stumble across.


I also found some words which seem to be spelled in multiple ways throughout. Some of the differences seemed typical of british VS american spelling but others I was unsure of. In any case, I did not modify examples like these.

Version 1 Version 2
colour color
parseable parsable
referenceable referencable
pickleable picklable
focusses focuses
parameterise parameterize

@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.

Thanks again to your contribution and we look forward to looking at it!

@mention-bot
Copy link

@delirious-lettuce, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @benjaminp and @bitdancer to be potential reviewers.

@serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir trivial labels May 19, 2017
@serhiy-storchaka serhiy-storchaka merged commit 3378b20 into python:master May 19, 2017
@serhiy-storchaka
Copy link
Member

Thank you for your patch @delirious-lettuce. I have no opinion about questionable examples, but the changes in the PR looks correct. You can open an issue on the bugtracker for discussing suspicious spelling. Just wondering how did you find all these typos?

Do you mind to backport your changes to other branches?

@delirious-lettuce
Copy link
Contributor Author

delirious-lettuce commented May 19, 2017

@serhiy-storchaka ,

I'm not sure the different spellings are really an issue other than it's slightly inconsistent. I can only imagine how many people from different countries have contributed to Python and have spelled the words correctly, according to their conventions. In Canada, we seem to use a bit of a mix of british and american spellings (colour/color, honour/honor). Many people might choose one side or the other and have valid reasons for doing so. I simply mentioned it for completeness and didn't want to start enforcing british or american spelling without proper input.

"Just wondering how did you find all these typos?"

I cloned the repo into PyCharm, went to Code > Inspect Code..., created a custom "scope" of file[cpython]:*/*.rst (to focus on documentation first) and clicked OK.

The problem was that the "Inspection Results" yielded over ~29,000 "typos" underneath "Spelling". This was not really an accurate number because the vast majority of the "typos" found were actually legitimate Python keywords/terms (functools, PYTHONPATH, argparse, etc) that weren't in PyCharms english dictionary (although PyCharm recognizes these terms just fine when they are in a .py file).

I ended up going through the .rst files inside the "Inspection Results" window one by one. It took me a few hours to scroll through the files and skim over each highlighted word to see whether they were legitimate typos or not. I'm almost certain that I will have missed some because of my method. It would have been much nicer to write a script to do it for me!

"Do you mind to backport your changes to other branches?"

Do you mean submit this same PR to each separate branch with these changes? I'd be more than happy to do that if you guys don't mind the multiple PR's. I just don't know how (or if it's possible) to send a PR to multiple branches at once. Also, there seems to be ~22 branches, could you be more specific about which ones you want me to send them too? I just don't want to upset the Python gods with 22 identical pull requests out of the blue!

@bitdancer
Copy link
Member

There is a backport tool mentioned in the devguide. The branches open for doc updates are master (3.7), 3.6, maybe 3.5? and 2.7.

We do prefer Amrican spelling as our standard, just to have something to be consistent around.

@bitdancer
Copy link
Member

I believe the "correct" spellings would be color, parseable, pickleable, referenceable, focuses, and parameterize.

@delirious-lettuce
Copy link
Contributor Author

@bitdancer ,

"There is a backport tool mentioned in the devguide. The branches open for doc updates are master (3.7), 3.6, maybe 3.5? and 2.7."

Thanks for the tip about the backport tool and the specific branches, I am just reading about cherry_picker.py now! Clearly, I should have read the devguide more thoroughly.

"We do prefer American spelling as our standard, just to have something to be consistent around."

Thanks for the clarification! I actually prefer the American spelling style over the British style too.

"I believe the "correct" spellings would be color, parseable, pickleable, referenceable, focuses, and parameterize."

Ok, I was just unsure because when I would google them, they would show both spellings. Does that mean I should push more changes to my branch before backporting?

@bitdancer
Copy link
Member

No, since Serhiy already pushed this, backport this. You should proabably open an issue for the spelling as Serhiy suggested, since there could be dissagreement.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants