NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

Improve code generated by boilerplate.py#10309

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

dstansby merged 1 commit intomatplotlib:masterfromtimhoffm:improve-boilerplate

Feb 2, 2018

Merged

Improve code generated by boilerplate.py#10309

dstansby merged 1 commit intomatplotlib:masterfromtimhoffm:improve-boilerplate

Feb 2, 2018

Conversation

Copy link

Member

timhoffm commentedJan 24, 2018

PR Summary

This PR improves the code generated byboilerplate.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 callingset_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 changed the title~~improve code generated by boilerplate.py~~Improve code generated by boilerplate.py

Jan 24, 2018

timhoffm added the Documentation label

Jan 24, 2018

timhoffm added this to thev2.2 milestone

Jan 24, 2018

Copy link

Contributor

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

Copy link

Member

dstansby commentedJan 29, 2018

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

improve code generated by boilerplate.py

087f312

timhoffm force-pushed theimprove-boilerplate branch from079a445 to087f312Compare

January 29, 2018 22:33

Copy link

MemberAuthor

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.

Copy link

Member

jklymak commentedFeb 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.