[issue30208] Small typos in IDLE doc
New submission from Cheryl Sabella: Fix some small typos in IDLE doc. ---------- assignee: docs@python components: Documentation messages: 292593 nosy: csabella, docs@python priority: normal severity: normal status: open title: Small typos in IDLE doc type: enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +1466 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: New changeset 9dc2b3809f38be2e403ee264958106badfda142d by terryjreedy (csabella) in branch 'master': bpo-30208: DOC: fix small typos in IDLE (#1354) https://github.com/python/cpython/commit/9dc2b3809f38be2e403ee264958106badfd... ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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? ---------- assignee: docs@python -> terry.reedy stage: -> backport needed versions: +Python 2.7, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Terry J. Reedy <tjreedy@udel.edu>: ---------- type: enhancement -> behavior _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +1468 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +1469 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +1470 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Cheryl Sabella added the comment: 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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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/5a8dcec93936de816cef5c17522e48fca9c... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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/52630ae17aa5bd8bffdb430b6515d07ffba... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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/4734c2d5c0529632e4b51eb75104b50955a... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment:
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.
---------- resolution: -> fixed stage: backport needed -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Cheryl Sabella added the comment: 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? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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. ---------- components: +IDLE _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Cheryl Sabella added the comment: LOL, well I made that a lot harder than you intended. :-) ---------- components: -Documentation _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
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> _______________________________________
Cheryl Sabella added the comment: 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:
---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +1466 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: New changeset 9dc2b3809f38be2e403ee264958106badfda142d by terryjreedy (csabella) in branch 'master': bpo-30208: DOC: fix small typos in IDLE (#1354) https://github.com/python/cpython/commit/9dc2b3809f38be2e403ee264958106badfd... ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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? ---------- assignee: docs@python -> terry.reedy stage: -> backport needed versions: +Python 2.7, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Terry J. Reedy <tjreedy@udel.edu>: ---------- type: enhancement -> behavior _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +1468 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +1469 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Changes by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +1470 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Cheryl Sabella added the comment: 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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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/5a8dcec93936de816cef5c17522e48fca9c... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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/52630ae17aa5bd8bffdb430b6515d07ffba... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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/4734c2d5c0529632e4b51eb75104b50955a... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment:
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.
---------- resolution: -> fixed stage: backport needed -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Cheryl Sabella added the comment: 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? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Terry J. Reedy added the comment: 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. ---------- components: +IDLE _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
Cheryl Sabella added the comment: LOL, well I made that a lot harder than you intended. :-) ---------- components: -Documentation _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
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> _______________________________________
Cheryl Sabella added the comment: 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:
---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30208> _______________________________________
participants (3)
-
Cheryl Sabella -
Mariatta Wijaya
-
Terry J. Reedy