Skip to content

DataFrame.plot docs broken #29489

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.

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
WillAyd opened this issue Nov 8, 2019 · 6 comments · Fixed by #31167
Closed

DataFrame.plot docs broken #29489

WillAyd opened this issue Nov 8, 2019 · 6 comments · Fixed by #31167
Assignees
Milestone

Comments

@WillAyd
Copy link
Member

WillAyd commented Nov 8, 2019

Not showing anything useful currently. I think the regression came between 0.24 and 0.25

0.25.0 docs:

https://pandas.pydata.org/pandas-docs/version/0.25.0/reference/api/pandas.DataFrame.plot.html

0.24.2 docs:
https://pandas.pydata.org/pandas-docs/version/0.24.2/reference/api/pandas.DataFrame.plot.html

@WillAyd WillAyd added the Docs label Nov 8, 2019
@WillAyd WillAyd added this to the Contributions Welcome milestone Nov 8, 2019
@datapythonista
Copy link
Member

This is a duplicate of #27748. I'm going to close that one, as contributors usually don't check old issues.

@JacksonDagger
Copy link

I'm gonna take a crack at this if no one else is working on it!

@JacksonDagger
Copy link

I'm still looking into this. I've discovered that this issue also affects Series.plot. Both plot classes use the PandasAutosummary class in conf.py and PlotAccessor

@datapythonista
Copy link
Member

I don't think the docstring was removed, so it should be only a question of setting it to the right object (which was probably unset during a big refactoring we did).

@chrisateen
Copy link

I noticed that in pandas.core.series.py and pandas.core.frame.py that both the DataFrame.plot method and the Series.plot method is create dynamically. See line 8146 for the Dataframe.plot and line 4393 for the Series.plot. For example on line 8146 in the pandas.core.frame.py file we have the code

plot = CachedAccessor("plot", pandas.plotting.PlotAccessor)

The documentation that is needed for both the series and the dataframe is in the pandas.plotting._core.py file where the class PlotAccessor is defined (line 543)

How can one set the documentation considering that the plot and series method is create dynamically?

@lithomas1
Copy link
Member

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants