Skip to content

Improve code generated by boilerplate.py#10309

Merged
dstansby merged 1 commit intomatplotlib:masterfrom
timhoffm:improve-boilerplate
Feb 2, 2018
Merged

Improve code generated by boilerplate.py#10309
dstansby merged 1 commit intomatplotlib:masterfrom
timhoffm:improve-boilerplate

Conversation

@timhoffm
Copy link
Copy Markdown
Member

@timhoffm timhoffm commented Jan 24, 2018

PR Summary

This PR improves the code generated by boilerplate.py. In particular

  • make the boilerplate-no-change-comment fit on one line (just aesthetics).
  • make the docstrings of the colormap-functions PEP8 conform.
  • change the code of the colormap functions to just calling set_colormap (the code from there was just duplicated). Below is an example of a changed colormap function as it's not easily readable in the diff.

Before:

def autumn():
    '''
    set the default colormap to autumn and apply to current image if any.
    See help(colormaps) for more information
    '''
    rc('image', cmap='autumn')
    im = gci()
    if im is not None:
        im.set_cmap(cm.autumn)

After:

def autumn():
    """
    Set the colormap to "autumn".

    This changes the default colormap as well as the colormap of the current
    image if there is one. See ``help(colormaps)`` for more information.
    """
    set_cmap("autumn")

@timhoffm timhoffm changed the title improve code generated by boilerplate.py Improve code generated by boilerplate.py Jan 24, 2018
@timhoffm timhoffm added this to the v2.2 milestone Jan 24, 2018
@anntzer
Copy link
Copy Markdown
Contributor

anntzer commented Jan 25, 2018

See also #9173...

jklymak
jklymak approved these changes Jan 26, 2018
View reviewed changes
Copy link
Copy Markdown
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to pass, but I think it will...

Yes @anntzer PR will gobble this one up, but this one doesn't hurt....

@dstansby
Copy link
Copy Markdown
Member

dstansby commented Jan 29, 2018

I think this might need a rebase to make the travis job pass

@timhoffm timhoffm force-pushed the improve-boilerplate branch from 079a445 to 087f312 Compare January 29, 2018 22:33
@timhoffm
Copy link
Copy Markdown
Member Author

timhoffm commented Feb 1, 2018

Do I have to do something about the codecov before merge? AFAICS none of the colormaps functions is tested and therefore all changed code is untested as well. But I don't think it's necessary to test these functions as they are trivial.

@jklymak
Copy link
Copy Markdown
Member

jklymak commented Feb 1, 2018

I think it not passing codecov is fine. I think if you want to be fancy you could tell codecov to not look at these files. Not merging, because this is a big enough change someone else should also look at it.

@dstansby dstansby merged commit db1cde0 into matplotlib:master Feb 2, 2018
@QuLogic QuLogic modified the milestones: needs sorting, v2.2.0 Feb 12, 2018
@timhoffm timhoffm deleted the improve-boilerplate branch December 17, 2018 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jklymak jklymak jklymak approved these changes

@dstansby dstansby dstansby approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

v2.2.0

Development

Successfully merging this pull request may close these issues.

5 participants

@timhoffm @anntzer @dstansby @jklymak @QuLogic