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

Jump to bottom

IDLE: Docstrings and test for colorizer #79870

Closed
csabella opened this issue Jan 8, 2019 · 5 comments
Closed

IDLE: Docstrings and test for colorizer #79870

csabella opened this issue Jan 8, 2019 · 5 comments
Assignees
@terryjreedy
Labels
3.7 (EOL) end of life 3.8 only security fixes topic-IDLE type-feature A feature request or enhancement

Comments

@csabella
Copy link
Contributor

csabella commented Jan 8, 2019

BPO 35689
Nosy @terryjreedy, @csabella
PRs
  • bpo-35689: IDLE: Add docstrings and unittests for colorizer.py #11472
  • [3.7] bpo-35689: IDLE: Add docstrings and unittests for colorizer.py (GH-11472) #11925
    		•

    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 2019-02-19.09:03:15.937>
created_at = <Date 2019-01-08.22:50:52.463>
labels = ['3.8', 'expert-IDLE', 'type-feature', '3.7']
title = 'IDLE: Docstrings and test for colorizer'
updated_at = <Date 2019-02-20.00:41:35.788>
user = 'https://github.com/csabella'

    bugs.python.org fields:

    activity = <Date 2019-02-20.00:41:35.788>
actor = 'cheryl.sabella'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2019-02-19.09:03:15.937>
closer = 'terry.reedy'
components = ['IDLE']
creation = <Date 2019-01-08.22:50:52.463>
creator = 'cheryl.sabella'
dependencies = []
files = []
hgrepos = []
issue_num = 35689
keywords = ['patch', 'patch', 'patch']
message_count = 5.0
messages = ['333263', '335883', '335886', '335887', '336030']
nosy_count = 2.0
nosy_names = ['terry.reedy', 'cheryl.sabella']
pr_nums = ['11472', '11925']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue35689'
versions = ['Python 3.7', 'Python 3.8']
    @csabella
    Copy link
    Contributor Author

    csabella commented Jan 8, 2019

    Add docstrings and unittests for colorizer.py.

    @csabella csabella added 3.7 (EOL) end of life 3.8 only security fixes labels Jan 8, 2019
    @csabella csabella added topic-IDLE type-feature A feature request or enhancement labels Jan 8, 2019
    @terryjreedy
    Copy link
    Member

    New changeset ee0f927 by Terry Jan Reedy (Cheryl Sabella) in branch 'master':
    bpo-35689: IDLE: Add docstrings and unittests for colorizer.py (GH-11472)
    ee0f927

    @terryjreedy
    Copy link
    Member

    Thank you for writing this. I was NOT looking forward to tackling tests for this module.

    I have thought about merging delegator and colorizer into one module, possibly with percolator included, and adding a module docstring that explains how they work together. This would still be only a few hundred lines. (And multiple htests in one file are not an issue.) What do you think?

    There is a suggestion in percolater that Percolater could subclass Delegator. I have not seriously looked at that idea yet.

    In the first code comment I mentioned a follow-up code change. Did you have anything in mind to work on or did you pick this for the fun and challenge?

    @miss-islington
    Copy link
    Contributor

    New changeset 99e9c36 by Miss Islington (bot) in branch '3.7':
    bpo-35689: IDLE: Add docstrings and unittests for colorizer.py (GH-11472)
    99e9c36

    @csabella
    Copy link
    Contributor Author

    I have thought about merging delegator and colorizer into one module, possibly with percolator included, and adding a module docstring that explains how they work together. This would still be only a few hundred lines. (And multiple htests in one file are not an issue.) What do you think?

    undo also uses delegator.Delegator as a base class. It might be odd for it to come from colorizer.delegator. I like the idea of explaining how they all work together though.

    I have not seriously looked at that idea yet.
    Neither have I. There are other things I'd like to get done (in this and other modules) before thinking about that one though.

    In the first code comment I mentioned a follow-up code change.

    OK, I'll create an issue for that. I really want to rename the any function too. It took a lot of willpower to not touch it when writing the tests. :-)

    Did you have anything in mind to work on or did you pick this for the fun and challenge?

    :-) Since the goal is to add tests for everything, I figured I'd tackle this one. But, I specifically thought it would be good to have tests in place in order to work on bpo-29287.

    @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 3.8 only security fixes topic-IDLE type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @terryjreedy @csabella @miss-islington