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.

Sign up for GitHub

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

Jump to bottom

Small typos in IDLE doc #74394

Closed
csabella opened this issue Apr 29, 2017 · 13 comments
Closed

Small typos in IDLE doc #74394

csabella opened this issue Apr 29, 2017 · 13 comments
Assignees
@terryjreedy
Labels
3.7 (EOL) end of life topic-IDLE type-bug An unexpected behavior, bug, or error

Comments

@csabella
Copy link
Contributor

BPO 30208
Nosy @terryjreedy, @Mariatta, @csabella
PRs
  • bpo-30208: DOC: fix small typos in IDLE #1354
  • [3.6] bpo-30208: DOC: fix small typos in IDLE #1356
  • [3.5] bpo-30208: DOC: fix small typos in IDLE #1357
  • [2.7] bpo-30208: DOC: fix small typos in IDLE #1358
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/terryjreedy'
closed_at = <Date 2017-04-30.00:49:42.461>
created_at = <Date 2017-04-29.13:42:38.557>
labels = ['expert-IDLE', 'type-bug', '3.7']
title = 'Small typos in IDLE doc'
updated_at = <Date 2017-05-02.21:36:31.451>
user = 'https://github.com/csabella'

    bugs.python.org fields:

    activity = <Date 2017-05-02.21:36:31.451>
actor = 'cheryl.sabella'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2017-04-30.00:49:42.461>
closer = 'terry.reedy'
components = ['IDLE']
creation = <Date 2017-04-29.13:42:38.557>
creator = 'cheryl.sabella'
dependencies = []
files = []
hgrepos = []
issue_num = 30208
keywords = []
message_count = 13.0
messages = ['292593', '292604', '292605', '292609', '292610', '292611', '292612', '292613', '292614', '292615', '292622', '292678', '292812']
nosy_count = 4.0
nosy_names = ['terry.reedy', 'docs@python', 'Mariatta', 'cheryl.sabella']
pr_nums = ['1354', '1356', '1357', '1358']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue30208'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6', 'Python 3.7']
    @csabella
    Copy link
    Contributor Author

    Fix some small typos in IDLE doc.

    @csabella csabella added type-feature A feature request or enhancement docs Documentation in the Doc dir labels Apr 29, 2017
    @terryjreedy
    Copy link
    Member

    New changeset 9dc2b38 by terryjreedy (csabella) in branch 'master':
    bpo-30208: DOC: fix small typos in IDLE (bpo-1354)
    9dc2b38

    @terryjreedy
    Copy link
    Member

    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?

    @terryjreedy terryjreedy added the 3.7 (EOL) end of life label Apr 29, 2017
    @terryjreedy terryjreedy added type-bug An unexpected behavior, bug, or error and removed type-feature A feature request or enhancement labels Apr 29, 2017
    @csabella
    Copy link
    Contributor Author

    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:

    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.

    @terryjreedy
    Copy link
    Member

    New changeset 5a8dcec by terryjreedy (csabella) in branch '3.6':
    [3.6] bpo-30208: DOC: fix small typos in IDLE (bpo-1356)
    5a8dcec

    @terryjreedy
    Copy link
    Member

    New changeset 52630ae by terryjreedy (csabella) in branch '3.5':
    [3.5] bpo-30208: DOC: fix small typos in IDLE (bpo-1357)
    52630ae

    @terryjreedy
    Copy link
    Member

    New changeset 4734c2d by terryjreedy (csabella) in branch '2.7':
    [2.7] bpo-30208: DOC: fix small typos in IDLE (bpo-1358)
    4734c2d

    @terryjreedy
    Copy link
    Member

    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.

    @csabella
    Copy link
    Contributor Author

    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?

    @terryjreedy
    Copy link
    Member

    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.

    @csabella
    Copy link
    Contributor Author

    LOL, well I made that a lot harder than you intended. :-)

    @csabella csabella removed the docs Documentation in the Doc dir label Apr 30, 2017
    @Mariatta
    Copy link
    Member

    Mariatta commented May 1, 2017

    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 :)

    @csabella
    Copy link
    Contributor Author

    csabella commented May 2, 2017

    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\>

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @terryjreedy terryjreedy

    Labels
    3.7 (EOL) end of life topic-IDLE type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @Mariatta @terryjreedy @csabella