8000 DOC improved subplots' docstring by NelleV · Pull Request #7232 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC improved subplots' docstring #7232

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 13, 2016
Merged

DOC improved subplots' docstring #7232

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
da9829f
DOC improved subplots' docstring
NelleV Oct 7, 2016
54d422a
FIX comments
NelleV Oct 8, 2016
2c98c6d
ENH better wording in the subplots docstring
NelleV Oct 8, 2016
20cd16a
DOC figure and pyplot's subplot docstring are now identical
NelleV Oct 11, 2016
a1e7282
DOC FIX axis -> x-axis in subplots
NelleV Oct 11, 2016
cf09849
DOC merged sharex/y in subplots docstrings
NelleV Oct 12, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jum 8000 p to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
ENH better wording in the subplots docstring
  • Loading branch information
@NelleV
NelleV committed Oct 8, 2016
commit 2c98c6da92f4b19394920653706134e4cfd3f793
16 changes: 8 additions & 8 deletions lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,20 +1054,20 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
Number of columns of the subplot grid.

sharex : bool or string, optional, default: False
- If True, the X axis will be shared amongst all subplots.
- If True, the x-axis will be shared amongst all subplots.
- If False, no axis will be shared amongst subplots.
Copy link
Member

Choose a reason for hiding this comment

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

axis -> x-axis

Copy link
Contributor

Choose a reason for hiding this comment

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

'no x-axis'?

Copy link
Member Author

Choose a reason for hiding this comment

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

nice catch.

- 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 a X axis.
- If "col", each subplot column will share a X axis.
- If "row", each subplot row will share a x-axis.
- If "col", each subplot column will share a x-axis.

Note that if the x-axis is shared across rows (sharex=True or
sharex="col") and nrows > 1 then the x tick labels won't be displayed
on any of plots but the ones on the bottom row.
sharex="col"), then the x tick labels will only be display on subplots
of the bottom row.

sharey : bool or string, optional, default: False
- If True, the Y axis will be shared amongst all subplots.
- If True, the y-axis will be shared amongst all subplots.
- If False, no y-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.
Expand All @@ -1076,8 +1076,8 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
- If "col", each subplot column will share a y-axis

Note that if the y-axis is shared across columns (sharey=False or
sharey="col") and ncols > 1 then the y tick labels won't be displayed
on any of the plots but the ones on the first column.
sharey="col"), 1 then the y tick labels will only be displayed on
subplots of the first column.

squeeze : bool, optional, default: True
Copy link
Member Author

Choose a reason for hiding this comment

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

I think there is an indentation problem around here, but I can't see it.

Copy link
Member Author

Choose a reason for hiding this comment

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

I found the problem and fixed it.

- If True, extra dimensions are squeezed out from the returned axis
Expand Down
0