This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Small typos in IDLE doc
Type: behavior Stage: resolved
Components: IDLE Versions: Python 3.7, Python 3.6, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: Mariatta, cheryl.sabella, docs@python, terry.reedy
Priority: normal Keywords:

Created on 2017-04-29 13:42 by cheryl.sabella, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 1354 merged cheryl.sabella, 2017-04-29 13:53
PR 1356 merged cheryl.sabella, 2017-04-30 00:24
PR 1357 merged cheryl.sabella, 2017-04-30 00:25
PR 1358 merged cheryl.sabella, 2017-04-30 00:26
Messages (13)
msg292593 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2017-04-29 13:42
Fix some small typos in IDLE doc.
msg292604 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-04-29 22:28
New changeset 9dc2b3809f38be2e403ee264958106badfda142d by terryjreedy (csabella) in branch 'master':
bpo-30208: DOC: fix small typos in IDLE (#1354)
https://github.com/python/cpython/commit/9dc2b3809f38be2e403ee264958106badfda142d
msg292605 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-04-29 23:00
Thank you for the review.  These are definitely bugs.  Please check IDLE component also for IDLE doc issues.  That will auto-assign them to me.

Your first merged PR?  If so, congrats.

Changes should be applied to at least 3.6, if not 3.5 and 2.7.  3.6 doc should be essentially identical, so I expect merge without conflict.  Likely true for others.  Can you (easily) prepare the PRs?  Can you use the cherry-pick script?
msg292609 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2017-04-30 00:31
I followed the steps for cherry-pick, but messed up a little as I made 3 PRs instead of one.  However, I couldn't do the labels asked for in this section:

When a cherry-pick was applied successfully, this script will open up a browser tab that points to the pull request creation page.

The url of the pull request page looks similar to the following:

https://github.com/python/cpython/compare/3.5...<username>:backport-6de2b78-3.5?expand=1

    Apply the appropriate cherry-pick for ... label
    Press the Create Pull Request button.
    Remove the needs backport to ... label from the original pull request against master.
msg292610 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-04-30 00:42
New changeset 5a8dcec93936de816cef5c17522e48fca9c30b43 by terryjreedy (csabella) in branch '3.6':
[3.6] bpo-30208: DOC: fix small typos in IDLE (#1356)
https://github.com/python/cpython/commit/5a8dcec93936de816cef5c17522e48fca9c30b43
msg292611 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-04-30 00:43
New changeset 52630ae17aa5bd8bffdb430b6515d07ffbaabc9e by terryjreedy (csabella) in branch '3.5':
[3.5] bpo-30208: DOC: fix small typos in IDLE (#1357)
https://github.com/python/cpython/commit/52630ae17aa5bd8bffdb430b6515d07ffbaabc9e
msg292612 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-04-30 00:44
New changeset 4734c2d5c0529632e4b51eb75104b50955afd692 by terryjreedy (csabella) in branch '2.7':
[2.7] bpo-30208: DOC: fix small typos in IDLE (#1358)
https://github.com/python/cpython/commit/4734c2d5c0529632e4b51eb75104b50955afd692
msg292613 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-04-30 00:49
From what I have seen, one PR for each branch is correct.  I believe cherry-pick.py was initially written by Mariatta.  Please bring up any problems or questions using it on core-mentorship, where she and others will see it.
msg292614 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2017-04-30 00:51
For this "Please check IDLE component also for IDLE doc issues.", I see the same text as the doc page in idlelib/help/html.  Is that the one you want me to change or is that created automatically by Sphinx?
msg292615 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-04-30 00:58
I mean 'IDLE' in the Components: box, to the left of the Versions: box, both in the 'classification' frame near the top of this page.
msg292622 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2017-04-30 09:22
LOL, well I made that a lot harder than you intended.  :-)
msg292678 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-05-01 17:25
One PR per branch is correct.

For future reference, preferably the commit hash to be cherry-picked is the one that is merged into CPython's master branch. It can be found at the original PR where it says <coredeveloper> merged commit <hash> into python:master. For PR 1353, it is 9dc2b38. 

For this issue, it doesn't make much difference since the PR contains only one commit. For PRs that contain multiple commits, it makes more sense to cherry-pick the squashed commit to master :)

Thanks :)
msg292812 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2017-05-02 21:36
Thank you for that information, Mariatta.  I had to read your description
twice to find the 9dc2b38 commit hash.  Once someone learns this, then they
will remember it, but you may want to highlight it on the cherry-pick
readme.  That was very well written and easy to follow, but I don't
remember it specifying the commit hash to use.

Cherry-pick is an awesome tool.  Can't wait to use it again!   :-)

On Mon, May 1, 2017 at 1:25 PM, Mariatta Wijaya <report@bugs.python.org>
wrote:

>
> Mariatta Wijaya added the comment:
>
> One PR per branch is correct.
>
> For future reference, preferably the commit hash to be cherry-picked is
> the one that is merged into CPython's master branch. It can be found at the
> original PR where it says <coredeveloper> merged commit <hash> into
> python:master. For PR 1353, it is 9dc2b38.
>
> For this issue, it doesn't make much difference since the PR contains only
> one commit. For PRs that contain multiple commits, it makes more sense to
> cherry-pick the squashed commit to master :)
>
> Thanks :)
>
> ----------
> nosy: +Mariatta
>
> _______________________________________
> Python tracker <report@bugs.python.org>
> <http://bugs.python.org/issue30208>
> _______________________________________
>
History
Date User Action Args
2022-04-11 14:58:45adminsetgithub: 74394
2017-05-02 21:36:31cheryl.sabellasetmessages: + msg292812
2017-05-01 17:25:05Mariattasetnosy: + Mariatta
messages: + msg292678
2017-04-30 09:22:51cheryl.sabellasetmessages: + msg292622
components: - Documentation
2017-04-30 00:58:02terry.reedysetmessages: + msg292615
components: + IDLE
2017-04-30 00:51:47cheryl.sabellasetmessages: + msg292614
2017-04-30 00:49:42terry.reedysetstatus: open -> closed
resolution: fixed
messages: + msg292613

stage: backport needed -> resolved
2017-04-30 00:44:06terry.reedysetmessages: + msg292612
2017-04-30 00:43:13terry.reedysetmessages: + msg292611
2017-04-30 00:42:05terry.reedysetmessages: + msg292610
2017-04-30 00:31:04cheryl.sabellasetmessages: + msg292609
2017-04-30 00:26:13cheryl.sabellasetpull_requests: + pull_request1470
2017-04-30 00:25:28cheryl.sabellasetpull_requests: + pull_request1469
2017-04-30 00:24:27cheryl.sabellasetpull_requests: + pull_request1468
2017-04-29 23:00:23terry.reedysettype: enhancement -> behavior
2017-04-29 23:00:02terry.reedysetassignee: docs@python -> terry.reedy
stage: backport needed
messages: + msg292605
versions: + Python 2.7, Python 3.5, Python 3.6, Python 3.7
2017-04-29 22:28:38terry.reedysetnosy: + terry.reedy
messages: + msg292604
2017-04-29 13:53:06cheryl.sabellasetpull_requests: + pull_request1466
2017-04-29 13:42:38cheryl.sabellacreate