X Tutup
Skip to content

Clarify wspace/hspace in documentation/comments#7399

Merged
NelleV merged 2 commits intomatplotlib:masterfrom
stilley2:master
Nov 4, 2016
Merged

Clarify wspace/hspace in documentation/comments#7399
NelleV merged 2 commits intomatplotlib:masterfrom
stilley2:master

Conversation

@stilley2
Copy link
Copy Markdown
Contributor

@stilley2 stilley2 commented Nov 4, 2016

Addresses #6939

@NelleV NelleV changed the title Clarify wspace/hspace in documentation/comments [MRG+1] Clarify wspace/hspace in documentation/comments Nov 4, 2016
Copy link
Copy Markdown
Member

@NelleV NelleV left a comment

Choose a reason for hiding this comment

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

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

@@ -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
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor Author

@stilley2 stilley2 Nov 4, 2016

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Nov 4, 2016

Thanks! 👍

@stilley2
Copy link
Copy Markdown
Contributor Author

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
@QuLogic QuLogic added this to the 2.1 (next point release) milestone Nov 7, 2016
@QuLogic QuLogic changed the title [MRG+1] Clarify wspace/hspace in documentation/comments Clarify wspace/hspace in documentation/comments Nov 7, 2016
@tacaswell
Copy link
Copy Markdown
Member

Thanks @stilley2!

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

tacaswell pushed a commit that referenced this pull request Nov 8, 2016
Clarify wspace/hspace in documentation/comments
@tacaswell
Copy link
Copy Markdown
Member

backported to v2.x as 3d3b8d2

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

@tacaswell tacaswell modified the milestones: 2.0.1 (next bug fix release), 2.1 (next point release) Nov 8, 2016
@QuLogic QuLogic modified the milestones: 2.0.1 (next bug fix release), 2.0 (style change major release) Dec 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

X Tutup