Clarify wspace/hspace in documentation/comments #7399

Merged
merged 2 commits into from Nov 4, 2016

Conversation

Projects
None yet
4 participants
Contributor

stilley2 commented Nov 4, 2016

Addresses #6939

@stilley2 stilley2 Clarify wspace/hspace in documentation/comments
0507459

NelleV changed the title from Clarify wspace/hspace in documentation/comments to [MRG+1] Clarify wspace/hspace in documentation/comments Nov 4, 2016

@NelleV

NelleV approved these changes Nov 4, 2016

Thanks for the patch!
This looks good. I have a minor nitpick, we can merge as is.

lib/matplotlib/figure.py
@@ -182,10 +182,12 @@ def __init__(self, left=None, bottom=None, right=None, top=None,
The top of the subplots of the figure
*wspace* : 0.2
@NelleV

NelleV Nov 4, 2016

Contributor

Do you mind removing the * around the keyword? We don't need them anymore.

@stilley2

stilley2 Nov 4, 2016 edited

Contributor

Just for wspace and hspace? The * seem to be ubiquitous. I guess my question is, how far should I go with this?

@NelleV

NelleV Nov 4, 2016

Contributor

Just for this function, else it'll take forever :)

@QuLogic

QuLogic Nov 4, 2016

Member

They're from a time before numpydoc; since numpydoc formats parameters in bold anyway, these have been made redundant. Just no-one's gone through to fix them yet.

@stilley2

stilley2 Nov 4, 2016

Contributor

Gotcha. Alright I went through and removed them in a bunch of places in that file. I figured while I was there I wouldn't limit myself to just one class.

@stilley2 stilley2 Remove astriks from keword arg doc strings
88ee53c
Contributor

NelleV commented Nov 4, 2016

Thanks! 👍

Contributor

stilley2 commented Nov 4, 2016

No problem. Feels good to contribute. I make heavy use of matplotlib.

@NelleV NelleV merged commit bdf2146 into matplotlib:master Nov 4, 2016

3 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 61.84%
Details

QuLogic added this to the 2.1 (next point release) milestone Nov 7, 2016

QuLogic changed the title from [MRG+1] Clarify wspace/hspace in documentation/comments to Clarify wspace/hspace in documentation/comments Nov 7, 2016

Owner

tacaswell commented Nov 8, 2016

Thanks @stilley2!

Congratulations on your first PR into mpl 🎉 Hopefully we will hear from you again!

@tacaswell tacaswell added a commit that referenced this pull request Nov 8, 2016

@NelleV @tacaswell NelleV + tacaswell Merge pull request #7399 from stilley2/master
Clarify wspace/hspace in documentation/comments
3d3b8d2
Owner

tacaswell commented Nov 8, 2016

backported to v2.x as 3d3b8d2

In general, I think all of the documentation changes should be backported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment