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

IDLE: configdialog -- add docstrings and improve comments #74960

Closed
terryjreedy opened this issue Jun 26, 2017 · 6 comments
Closed

IDLE: configdialog -- add docstrings and improve comments #74960

terryjreedy opened this issue Jun 26, 2017 · 6 comments
Assignees
Labels
3.7 (EOL) end of life topic-IDLE type-feature A feature request or enhancement

Comments

@terryjreedy
Copy link
Member

BPO 30777
Nosy @terryjreedy, @vstinner, @mlouielu, @csabella
PRs
  • bpo-30777: IDLE: configdialog - add docstrings and improve comments #2440
  • bpo-30777 NEWS #2576
  • [3.6] bpo-30777: IDLE: configdialog - add docstrings and improve comm… #2577
  • [3.6] bpo-30777 NEWS (GH-2576) #2579
  • 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-07-05.04:56:34.363>
    created_at = <Date 2017-06-26.21:57:01.952>
    labels = ['expert-IDLE', 'type-feature', '3.7']
    title = 'IDLE: configdialog -- add docstrings and improve comments'
    updated_at = <Date 2017-07-05.20:21:52.677>
    user = 'https://github.com/terryjreedy'

    bugs.python.org fields:

    activity = <Date 2017-07-05.20:21:52.677>
    actor = 'terry.reedy'
    assignee = 'terry.reedy'
    closed = True
    closed_date = <Date 2017-07-05.04:56:34.363>
    closer = 'terry.reedy'
    components = ['IDLE']
    creation = <Date 2017-06-26.21:57:01.952>
    creator = 'terry.reedy'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 30777
    keywords = []
    message_count = 6.0
    messages = ['296955', '297030', '297059', '297693', '297699', '297778']
    nosy_count = 4.0
    nosy_names = ['terry.reedy', 'vstinner', 'louielu', 'cheryl.sabella']
    pr_nums = ['2440', '2576', '2577', '2579']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue30777'
    versions = ['Python 3.6', 'Python 3.7']

    @terryjreedy
    Copy link
    Member Author

    Spinoff from bpo-30728. Docstrings are a form of comment. Both leave behavior alone and do not require testing, just human review. Add the docstrings from the original version of PR 2307, and any others. Review and fix comments in light of the comments on that PR.

    @terryjreedy terryjreedy added type-feature A feature request or enhancement topic-IDLE labels Jun 26, 2017
    @terryjreedy terryjreedy self-assigned this Jun 26, 2017
    @csabella
    Copy link
    Contributor

    I've made a PR for the docstrings and comments. I didn't change any of the comments separating the sections in the create* functions as I wasn't sure how you wanted those changed. When reading the code, I found the comments helpful in that they separated each section, but whitespace might be just as helpful, visually.

    Thanks!

    @terryjreedy
    Copy link
    Member Author

    Louie, perhaps you would like to review the PR, especially the comment revisions responding to your comments.

    @terryjreedy
    Copy link
    Member Author

    New changeset 7eb5883 by terryjreedy (csabella) in branch 'master':
    bpo-30777: IDLE: configdialog - add docstrings and improve comments (bpo-2440)
    7eb5883

    @terryjreedy
    Copy link
    Member Author

    New changeset e5bb112 by terryjreedy in branch '3.6':
    [3.6] bpo-30777: IDLE: configdialog - add docstrings and improve comments (GH-2440) (bpo-2577)
    e5bb112

    @terryjreedy
    Copy link
    Member Author

    Unlinked bogus revert message. configdialog still has new docstrings.

    @terryjreedy terryjreedy added the 3.7 (EOL) end of life label Jul 5, 2017
    @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
    Labels
    3.7 (EOL) end of life topic-IDLE type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants