DOC improved subplots' docstring #7232
DOC FIX axis -> x-axis in subplots
- Loading branch information
commit a1e728206664d5202730d0700e6612b487665c4a
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1030,12 +1030,12 @@ def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False, | |
|
|
||
| sharex : {"none", "all", "row", "col"} or bool, default: False | ||
| - If True, the x-axis will be shared amongst all subplots. | ||
| - If False, no x-axis will be shared amongst subplots. | ||
| - If a string must be one of "row", "col", "all", or "none". | ||
| - "all" has the same effect as True. | ||
| - "none" has the same effect as False. | ||
| - If "row", each subplot row will share an x-axis. | ||
| - If "col", each subplot column will share an x-axis. | ||
|
|
||
| Note that if the x-axis is shared across rows (sharex=True or | ||
| sharex="col"), then the x tick labels will only be display on | ||
|
|
@@ -1048,26 +1048,26 @@ def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False, | |
| - "all" has the same effect as True. | ||
| - "none" has the same effect as False. | ||
| - If "row", each subplot row will share a y-axis. | ||
| - If "col", each subplot column will share an y-axis | ||
|
|
||
| Note that if the y-axis is shared across columns (sharey=True or | ||
| sharey="col"), then the y tick labels will only be displayed on | ||
| subplots of the first column. | ||
|
|
||
| squeeze : bool, default: True | ||
| - If True, extra dimensions are squeezed out from the returned | ||
| axis object: | ||
|
|
||
| - if only one subplot is constructed (nrows=ncols=1), the | ||
| resulting single Axes object is returned as a scalar. | ||
| - for Nx1 or 1xN subplots, the returned object is a 1D numpy | ||
| object array of Axes objects are returned as numpy 1D | ||
| arrays. | ||
|
There was a problem hiding this comment. Isn't there an extra verb in this sentence? Wouldn't be OK something like: 'for Nx1 or 1xN subplots, the returned object is a 1-d numpy object array of Axes instances' There was a problem hiding this comment. @NelleV I think you may have missed this one. |
||
| - for NxM, subplots with N>1 and M>1 are returned as a 2D | ||
| arrays. | ||
|
There was a problem hiding this comment.
|
||
|
|
||
| - If False, no squeezing at all is done: the returned Axes object | ||
| is always a 2D array containing Axes instances, even if it ends | ||
| up being 1x1. | ||
|
|
||
|
There was a problem hiding this comment. Shouldn't all the 'Axis' in ll.1058-1071 be replaced with 'Axes'? There was a problem hiding this comment. Yes, this is a very important distinction! |
||
| subplot_kw : dict, default: {} | ||
|
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'..the return object'