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

Provide a link to the px reference page on every chart page #2784

Closed
chriddyp opened this issue Sep 21, 2020 · 8 comments
Closed

Provide a link to the px reference page on every chart page #2784

chriddyp opened this issue Sep 21, 2020 · 8 comments
Assignees

Comments

@chriddyp
Copy link
Member

We currently link to the graph objects reference page, but not to the px sunburst page.

image

@emmanuelle
Copy link
Contributor

For interested contributors, the px reference page is https://plotly.com/python-api-reference/plotly.express.html. Please read the Readme in https://github.com/plotly/plotly.py/tree/master/doc to learn how the doc is organized and edited.

@ry-v1
Copy link
Contributor

ry-v1 commented Oct 3, 2020

@chriddyp @emmanuelle - I can work on this, can you please assign it to me.
Is the below format is fine.

Reference
See https://plotly.com/python/reference/sunburst/ or https://plotly.com/python-api-reference/generated/plotly.express.sunburst.html for more information and chart attribute options!

I do see px site doesn't have documentation for all the charts like bubble, bullet and candlestick chart.

@emmanuelle
Copy link
Contributor

Assigned! Yes, plotly.express does not have (yet) functions for all traces. You can find the list of available functions in https://plotly.com/python-api-reference/plotly.express.html.

For the format it looks good, just put the plotly.express link first please.

@ry-v1
Copy link
Contributor

ry-v1 commented Oct 5, 2020

Sure, will do

@nicolaskruchten
Copy link
Contributor

For the PX link it might be nice to have some link text like "function reference for px.scatter()" instead of that big URL?

@ry-v1
Copy link
Contributor

ry-v1 commented Oct 5, 2020

How about this?

Reference
See function reference for px.sunburst() or https://plotly.com/python/reference/sunburst/ for more information and chart attribute options!

@nicolaskruchten
Copy link
Contributor

I would use something like this:

See function reference for px.sunburst() or ...

with the following code:

See [function reference for `px.sunburst()`](https://plotly.com/python-api-reference/generated/plotly.express.sunburst) or ...

@ry-v1 ry-v1 mentioned this issue Oct 6, 2020
22 tasks
@ry-v1
Copy link
Contributor

ry-v1 commented Oct 6, 2020

I have submitted pull request #2784. Please check.

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

No branches or pull requests

4 participants