DOC: Fix docstring for tsplot #17814
Conversation
pandas/plotting/_timeseries.py
Outdated
| ax : matplotlib axes object, optional, default=None | ||
| Axis to plot upon. If none, plots on current axis. | ||
| kwargs | ||
| Additional keywords arguments passed to plotf. |
There was a problem hiding this comment.
"keywords arguments" -> "keyword arguments"
Codecov Report
@@ Coverage Diff @@
## master #17814 +/- ##
==========================================
- Coverage 91.26% 91.24% -0.02%
==========================================
Files 163 163
Lines 49978 49978
==========================================
- Hits 45611 45602 -9
- Misses 4367 4376 +9
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #17814 +/- ##
==========================================
- Coverage 91.26% 91.24% -0.02%
==========================================
Files 163 163
Lines 49978 49980 +2
==========================================
- Hits 45611 45604 -7
- Misses 4367 4376 +9
Continue to review full report at Codecov.
|
pandas/plotting/_timeseries.py
Outdated
| @@ -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 axis. | |||
There was a problem hiding this comment.
I think that matplotlib uses the phrase "current axes", so the old way was correct here. "axis" is for the "x" or "y" axis of an axes :)
Good you change that back here and on line 33?
|
@TomAugspurger : |
|
Not that I don't want better docstrings (@TomDonogue thanks for contributing on that part!), but shouldn't this function rather be removed/deprecated? We don't use it internally, and it is not exposed in the |
|
@jorisvandenbossche Point being, if it's better to deprecate, that makes sense to me - let me know if there is anything I can / should do on my end. |
|
@TomDonoghue can you deprecate this function? add a test for the deprecation & mention in the whatsnew for 0.22 |
|
closing as stale. if you want to re-visit this pls ping. |
|
@TomDonoghue Still welcome to do a PR to deprecate the function instead! (opened #18627 for this) |
Browsing through pandas, I noticed a small plotting function who's docs were incomplete / out of date. This is a small update to the docstring for tsplot in plotting/_timeseries.
git diff upstream/master -u -- "*.py" | flake8 --diff