Skip to content

DOC: Fix docstring for tsplot #17814

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

Closed
wants to merge 3 commits into from
Closed

DOC: Fix docstring for tsplot #17814

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a5e82e
DOC: Fix docstring for tsplot
TomDonoghue Oct 7, 2017
55bd4a5
Fix typo
TomDonoghue Oct 7, 2017
5326533
Fix type on 'axes'
TomDonoghue Oct 8, 2017
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
18 changes: 12 additions & 6 deletions pandas/plotting/_timeseries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,22 @@

def tsplot(series, plotf, ax=None, **kwargs):
"""
Plots a Series on the given Matplotlib axes or the current axes
Plots a Series on the given Matplotlib axes or the current axes.

Parameters
----------
axes : Axes
series : Series

Notes
_____
Supports same kwargs as Axes.plot
plotf : function
Function to plot the given Series.
ax : matplotlib axes object, optional, default=None
Axes to plot upon. If none, plots on current axis.
kwargs
Additional keyword arguments passed to plotf.

Returns
-------
lines : list of matplotlib.lines.Line2D object
Resultant figure.

"""
# Used inferred freq is possible, need a test case for inferred
Expand Down