Skip to content

Update _core.py with missing parameters #33596

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 3 commits into from
May 6, 2020
Merged

Update _core.py with missing parameters #33596

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a402b1c
Update _core.py
loudlemon Apr 16, 2020
e2f13f5
Update _core.py
loudlemon Apr 16, 2020
423a516
update plot accessor docstring
loudlemon May 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,8 +606,21 @@ class PlotAccessor(PandasObject):
- 'pie' : pie plot
- 'scatter' : scatter plot
- 'hexbin' : hexbin plot.

ax : matplotlib axes object, default None
An axes of the current figure.
subplots : bool, default False
Make separate subplots for each column.
sharex : bool, default True if ax is None else False
In case subplots=True, share x axis and set some x axis labels
to invisible; defaults to True if ax is None otherwise False if
an ax is passed in; Be aware, that passing in both an ax and
sharex=True will alter all x axis labels for all axis in a figure.
sharey : bool, default False
In case aubplots=True, share y axis and set some y axis labels to invisible.
Copy link
Member

Choose a reason for hiding this comment

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

Typo, subplots.

Also, if you don't mind, can you quote in double backticks all these param=value cases. For example :

In case ``subplot=True``, share...

layout : tuple (optional)
Copy link
Member

Choose a reason for hiding this comment

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

tuple, optional

(rows, columns) for the layout of subplots.
figsize : a tuple (width, height) in inches
Size of a figure object.
use_index : bool, default True
Use index as ticks for x axis.
title : str or list
Expand Down Expand Up @@ -637,7 +650,9 @@ class PlotAccessor(PandasObject):
yticks : sequence
Values to use for the yticks.
xlim : 2-tuple/list
Set the x limits of the current axes.
ylim : 2-tuple/list
Set the y limits of the current axes.
rot : int, default None
Rotation for ticks (xticks for vertical, yticks for horizontal
plots).
Expand All @@ -663,6 +678,13 @@ class PlotAccessor(PandasObject):
detail.
xerr : DataFrame, Series, array-like, dict and str
Equivalent to yerr.
stacked : bool, default False in line and bar plots, and True in area plot
If True, create stacked plot.
sort_columns : bool, default False
Sort columns names to determine plot ordering.
Copy link
Member

Choose a reason for hiding this comment

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

Not sure, but shouldn't be "column names"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that's right, column names, should have checked for all these inaccuracies
thanks for your time!
I'll make changes shortly

secondary_y : bool or sequence, default False
Whether to plot on the secondary y-axis if a list/tuple, which
columns to plot on secondary y-axis.
mark_right : bool, default True
When using a secondary_y axis, automatically mark the column
labels with "(right)" in the legend.
Expand Down