fix axes barh default align option document #7758
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
QuLogic
reviewed
Jan 7, 2017
| @@ -2259,7 +2259,7 @@ def barh(self, bottom, width, height=0.8, left=None, **kwargs): | |||
| dictionary of kwargs to be passed to errorbar method. `ecolor` and | |||
| `capsize` may be specified here rather than as independent kwargs. | |||
|
|
|||
| align : ['edge' | 'center'], optional, default: 'edge' | |||
| align : ['edge' | 'center'], optional | |||
There was a problem hiding this comment.
Can you change this to use the format of bar with braces? The default is the first item, so change the order.
There was a problem hiding this comment.
@QuLogic Done. The direction words are really fallible and I checked several time and being afraid to make mistakes.
tacaswell
approved these changes
Jan 7, 2017
|
@lspvic I went ahead and added a commit to fix the whitespace issues, I hope you do not mind. |
|
Who ever merges this, please remember to backport it! |
|
@tacaswell Never mind. |
Current coverage is 62.12% (diff: 100%)@@ master #7758 diff @@
==========================================
Files 174 174
Lines 56028 56028
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
Hits 34805 34805
Misses 21223 21223
Partials 0 0
|
phobson
approved these changes
Jan 8, 2017
phobson
added a commit
that referenced
this pull request
Jan 8, 2017
DOC: fix Axes.barh default alignment option
|
backported to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since 2.0, default
alignoption ofbarandbarhhave changed to 'center', and the docstring ofbarhas been updated, but that ofbarhis not. This PR fix the docstring asbar.In addition, the default
alignoption ofbaris not presented in the docstring like:I'm not quite sure this will be appended to end of the docstring, because some other options in this page give the default value while some are not. If this default value should be appended, I will update this PR.