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

Wishlist: doc examples wanted #1965

Open
emmanuelle opened this issue Nov 28, 2019 · 12 comments
Open

Wishlist: doc examples wanted #1965

emmanuelle opened this issue Nov 28, 2019 · 12 comments

Comments

@emmanuelle
Copy link
Collaborator

@emmanuelle emmanuelle commented Nov 28, 2019

Most items coming from questions on the community forum

@nicolaskruchten nicolaskruchten transferred this issue from plotly/plotly.py-docs Dec 3, 2019
@emmanuelle
Copy link
Collaborator Author

@emmanuelle emmanuelle commented Jan 23, 2020

I've tagged this issue as a good first issue since some examples are quite easy to add (especially if the forum posts have some code examples). Items which have already been ticked are already done. Feel free to ask questions here if you would like to contribute an example but are unsure about how to do it. Please also refer to the doc README https://github.com/plotly/plotly.py/blob/master/doc/README.md

@emmanuelle emmanuelle pinned this issue Jan 23, 2020
@Mahdis-z Mahdis-z unpinned this issue Jan 27, 2020
@nicolaskruchten nicolaskruchten pinned this issue Jan 30, 2020
@nicolaskruchten nicolaskruchten changed the title Wishlist: examples wanted Wishlist: doc examples wanted Jan 30, 2020
@emmanuelle
Copy link
Collaborator Author

@emmanuelle emmanuelle commented Feb 13, 2020

Here is also a couple of searches with no result on the doc website, which should return something

  • lasso and box selection (we do have a page for selection-events but it's for FigureWidget, we don't have anything for selections in plotly figures I believe, only in the config page maybe)
  • io
  • modebar
  • various figure factory names (create_gantt, create_distplot, create_trisurf)
  • drilldown (to be added to sunburst and treemap)
  • figsize (this is the matplotlib parameter, we might mention in when talking about the width and height of a figure).
@SylwiaOliwia2
Copy link
Contributor

@SylwiaOliwia2 SylwiaOliwia2 commented Feb 24, 2020

I can help with that (I have experience with Plotly, but it's my first Open Source contribution). Are some of the tasks in progress? Or I can pick any that is not done?

@emmanuelle
Copy link
Collaborator Author

@emmanuelle emmanuelle commented Feb 24, 2020

Thank you @SylwiaOliwia2! I've updated the list by ticking contributions in progress, it was indeed not completely up to date :-). You can also write here on which example you would like to work on, or tick the corresponding box so that we know you're working on it. Thanks again :-)

@SylwiaOliwia2
Copy link
Contributor

@SylwiaOliwia2 SylwiaOliwia2 commented Feb 25, 2020

I'll start with the following:

  • add coloraxis example to the subplots tutorial - Pull request #2226
  • example with legend only for a trace - Pull request #2227
  • add an example with matching axes (matches="x")
  • on histogram tutorial, mention that we cannot access the values of counts (it's asked a lot), and maybe mention numpy's function for this. #2242

I'll keep updating this post about the tasks resolved by me.

SylwiaOliwia2 added a commit to SylwiaOliwia2/plotly.py that referenced this issue Feb 25, 2020
Add information about coloraxis in subplots.  Issue plotly#1965.
@SylwiaOliwia2
Copy link
Contributor

@SylwiaOliwia2 SylwiaOliwia2 commented Feb 27, 2020

@emmanuelle

on histogram tutorial, mention that we cannot access the values of counts (it's asked a lot), and maybe mention numpy's function for this.

you mean that we can't display the total count of the histogram (ex. 25 for the selected items below)?
Plotly_hist

@emmanuelle
Copy link
Collaborator Author

@emmanuelle emmanuelle commented Mar 2, 2020

@SylwiaOliwia2 thanks for your PRs! Regarding the histogram, what I meant is that you cannot access the count values from Python. As you show in the figure, you can indeed see the count in the hover but it stays in Javascript. Is this clear enough? This confused me a bit when I started using plotly.py

nicolaskruchten added a commit that referenced this issue Mar 6, 2020
Add information about coloraxis in subplots.  Issue #1965.
@emmanuelle
Copy link
Collaborator Author

@emmanuelle emmanuelle commented Mar 13, 2020

I removed some of the completed examples from the list, so that the existing list is more readable.

@SylwiaOliwia2
Copy link
Contributor

@SylwiaOliwia2 SylwiaOliwia2 commented Mar 19, 2020

  • example with colored links in sankey page #2291
  • in slider page, add example using the update method #2300
@SylwiaOliwia2
Copy link
Contributor

@SylwiaOliwia2 SylwiaOliwia2 commented Mar 19, 2020

@emanuelle, regarding

example of shape or annotation covering several subplots thanks to xref='paper'

The xref="paper" makes the annotation static and assumes that all the subplots are one plotting area. That's the point? It seems to be good to add custom legend or description, but not to annotate within the plot. See the example code here.

@ineelshah
Copy link

@ineelshah ineelshah commented May 29, 2020

Is this issue still open?
I want to contribute to it if there is some good first issue to be solved!
Can anyone guide?

@nicolaskruchten
Copy link
Member

@nicolaskruchten nicolaskruchten commented May 29, 2020

This issue is still open, although some have been addressed in #2488 which hasn't been merged yet.

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

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.