Skip to content

Documentation for 5.10 features #3818

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

Merged
merged 35 commits into from
Jul 26, 2022
Merged

Documentation for 5.10 features #3818

merged 35 commits into from
Jul 26, 2022

Conversation

LiamConnors
Copy link
Member

@LiamConnors LiamConnors commented Jul 19, 2022

Documentation PR

  • I've seen the doc/README.md file
  • This change runs in the current version of Plotly on PyPI and targets the doc-prod branch OR it targets the master branch
  • If this PR modifies the first example in a page or adds a new one, it is a px example if at all possible
  • Every new/modified example has a descriptive title and motivating sentence or paragraph
  • Every new/modified example is independently runnable
  • Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized
  • Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible
  • The random seed is set if using randomly-generated data in new/modified examples
  • New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets
  • Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations
  • Imports are plotly.graph_objects as go / plotly.express as px / plotly.io as pio
  • Data frames are always called df
  • fig = <something> call is high up in each new/modified example (either px.<something> or make_subplots or go.Figure)
  • Liberal use is made of fig.add_* and fig.update_* rather than go.Figure(data=..., layout=...) in every new/modified example
  • Specific adders and updaters like fig.add_shape and fig.update_xaxes are used instead of big fig.update_layout calls in every new/modified example
  • fig.show() is at the end of each new/modified example
  • plotly.plot() and plotly.iplot() are not used in any new/modified example
  • Hex codes for colors are not used in any new/modified example in favour of these nice ones

Sorry, something went wrong.

@LiamConnors LiamConnors changed the title Docs for 5.10 Documentation for 5.10 features Jul 19, 2022
@LiamConnors LiamConnors marked this pull request as ready for review July 19, 2022 23:28
LiamConnors and others added 6 commits July 21, 2022 11:51
Co-authored-by: Mojtaba Samimi <33888540+archmoj@users.noreply.github.com>
Co-authored-by: Mojtaba Samimi <33888540+archmoj@users.noreply.github.com>
@LiamConnors LiamConnors requested a review from archmoj July 21, 2022 20:53
LiamConnors and others added 7 commits July 22, 2022 12:47
Co-authored-by: Mojtaba Samimi <33888540+archmoj@users.noreply.github.com>
Co-authored-by: Mojtaba Samimi <33888540+archmoj@users.noreply.github.com>
Co-authored-by: Mojtaba Samimi <33888540+archmoj@users.noreply.github.com>
fig.show()
```

## Styling New Selections
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move this section above Fill Color for Active Selections section as it is a more useful attribute to know.

@archmoj
Copy link
Contributor

archmoj commented Jul 22, 2022

Fantastic! Thank you @LiamConnors 🏆

@nicolaskruchten
Copy link
Contributor

@LiamConnors the build is failing here because you haven't merged master into your branch... could you please do so and push, so that we can confirm that the build is green before we merge?

thumbnail: thumbnail/make_selection.jpg
---

## Adding Selections to Cartesian Subplots
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this document is great, but one thing which is missing is some indication to the reader of how to retrieve the selection values! We will need a link to some Dash documentation or something that folks can follow to actually do something with the selection once the user does it!

Do the selected values come back out using fig.full_figure_for_development() in a way that we can statically demo in the docs here?

@nicolaskruchten nicolaskruchten merged commit 04cde13 into master Jul 26, 2022
@LiamConnors LiamConnors deleted the docs-5-10 branch August 9, 2022 19:23
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

Successfully merging this pull request may close these issues.

None yet

3 participants