Skip to content
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

Update plot docs when backend is set. #28618

Open
TomAugspurger opened this issue Sep 25, 2019 · 2 comments
Open

Update plot docs when backend is set. #28618

TomAugspurger opened this issue Sep 25, 2019 · 2 comments
Labels

Comments

@TomAugspurger
Copy link
Contributor

As part of the backend callback, can / should we copy the docstring from the backend to the DataFrame.plot object (including methods like DataFrame.plot.scatter)?

There may be backend-specific notes or behavior. It'd be nice if those were transferred over.

cc @jsignell.

@TomAugspurger TomAugspurger added the Visualization plotting label Sep 25, 2019
@jsignell
Copy link
Contributor

Just for reference, this is where I've been working on the hvPlot entrypoint holoviz/hvplot#319

@jsignell
Copy link
Contributor

I guess the question is should the docs be over-written with the docs from the backend, or should the docs be augmented with additional docs?

Also worth thinking about how this will work when #28622 is added since that will make it impossible to know which backend to show docs for. The backend set in the options.plotting.backend could just always be used.

I guess I am leaning towards not overwriting the docs, since the positional arguments will have to be the same. I do think there could be a way to overwrite the examples. And I could go through and generalize references to matplotlib.

@mroeschke mroeschke added the Docs label Jul 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants