-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Elaborate on difference between Plotly Express and Graph Objects functions #5150
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
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
emilykl
emilykl
reviewed
Apr 29, 2025
Thank you for the contribution @afeld !
I'm in favor of this change, I think it's a helpful clarification. @LiamConnors What do you think?
Co-authored-by: Emily KL <4672118+emilykl@users.noreply.github.com>
@gvwilson
gvwilson
added
community
community contribution
fix
fixes something broken
documentation
written for humans
P1
needed for current cycle
labels
Apr 30, 2025
LiamConnors
LiamConnors
approved these changes
May 15, 2025
@LiamConnors
LiamConnors
merged commit May 16, 2025
a06de16
into
plotly:doc-prod
3 of 4 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello! I teach Plotly in one of my classes, and as I was reading through this documentation, I felt it could be more explicit about how data is passed into the different plotting functions.
Thanks!
Documentation PR
doc/README.md
filedoc-prod
branch(削除) OR it targets themain
branch (削除ここまで)(削除) If this PR modifies the first example in a page or adds a new one, it is apx
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 areplotly.graph_objects as go
/plotly.express as px
/plotly.io as pio
(削除ここまで)(削除) Data frames are always calleddf
(削除ここまで)(削除)fig = <something>
call is high up in each new/modified example (eitherpx.<something>
ormake_subplots
orgo.Figure
) (削除ここまで)(削除) Liberal use is made offig.add_*
andfig.update_*
rather thango.Figure(data=..., layout=...)
in every new/modified example (削除ここまで)(削除) Specific adders and updaters likefig.add_shape
andfig.update_xaxes
are used instead of bigfig.update_layout
calls in every new/modified example (削除ここまで)(削除)fig.show()
is at the end of each new/modified example (削除ここまで)(削除)plotly.plot()
andplotly.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 (削除ここまで)