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 (.:: should typically just be ::). #6165

Merged
merged 1 commit into from
Mar 28, 2018

Conversation

JulienPalard
Copy link
Member

Found them using:

git grep "\.::" Doc/ | grep -v 'e\.g\.::'

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

I think it should be rather . ::.

@@ -60,7 +60,7 @@ program. So, how do you arrange for the interpreter to handle your Python?
First, you need to make sure that your command window recognises the word
"python" as an instruction to start the interpreter. If you have opened a
command window, you should try entering the command ``python`` and hitting
return.::
return::
Copy link
Member

Choose a reason for hiding this comment

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

This should be . :: (needed a space between . and ::).

Copy link
Member

Choose a reason for hiding this comment

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

:: gets displayed as :, so it's wrong to add a point before it.

Copy link
Member

Choose a reason for hiding this comment

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

:: after a space is not displayed, but just starts a code block. I believe this was the initial intention of the author of this text. See other occurrences of . :: in the documentation.

Copy link
Member Author

Choose a reason for hiding this comment

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

The following block is clearly the example of the explained sentence. Sentence is "entering the command python and hitting return", bloc is "C:\Users\YourName> python", so ":" make more sense than "." here, am I wrong?

@serhiy-storchaka serhiy-storchaka added needs backport to 3.6 docs Documentation in the Doc dir labels Mar 21, 2018
@@ -60,7 +60,7 @@ program. So, how do you arrange for the interpreter to handle your Python?
First, you need to make sure that your command window recognises the word
"python" as an instruction to start the interpreter. If you have opened a
command window, you should try entering the command ``python`` and hitting
return.::
return::
Copy link
Member

Choose a reason for hiding this comment

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

:: after a space is not displayed, but just starts a code block. I believe this was the initial intention of the author of this text. See other occurrences of . :: in the documentation.

@bedevere-bot
Copy link

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

@serhiy-storchaka serhiy-storchaka dismissed their stale review March 27, 2018 09:11

Both variants are valid here.

@JulienPalard JulienPalard merged commit 7855313 into python:master Mar 28, 2018
@miss-islington
Copy link
Contributor

Thanks @JulienPalard for the PR 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.6, 3.7.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-6300 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 Mar 28, 2018
(cherry picked from commit 7855313)

Co-authored-by: Julien Palard <julien@palard.fr>
@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 28, 2018
(cherry picked from commit 7855313)

Co-authored-by: Julien Palard <julien@palard.fr>
@miss-islington
Copy link
Contributor

Sorry, @JulienPalard, I could not cleanly backport this to 2.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 78553138be3b38d361bded8e641a2a4fd65a9d16 2.7

ned-deily pushed a commit that referenced this pull request Mar 29, 2018
(cherry picked from commit 7855313)

Co-authored-by: Julien Palard <julien@palard.fr>
@serhiy-storchaka
Copy link
Member

Do you mind to create a backport to 2.7 @JulienPalard?

JulienPalard added a commit to JulienPalard/cpython that referenced this pull request May 16, 2018
(cherry picked from commit 7855313)

Co-authored-by: Julien Palard <julien@palard.fr>
JulienPalard added a commit that referenced this pull request May 19, 2018
@JulienPalard JulienPalard deleted the typo branch June 16, 2019 14:07
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants