You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -19,16 +19,16 @@ the structure of the code and of the repository.
19
19
20
20
-[the `plotly.graph_objects` module](https://plotly.com/python/graph-objects/) (usually imported as `go`)
21
21
is [generated from the Plotly.js schema](https://plotly.com/python/figure-structure/),
22
-
so changes to be made in this package need to be
23
-
[contributed to Plotly.js](https://github.com/plotly/plotly.js) or to the `codegen` system
22
+
so changes to be made in this package need to be
23
+
[contributed to Plotly.js](https://github.com/plotly/plotly.js) or to the `codegen` system
24
24
in `packages/python/plotly/codegen`. Most of the codegen code concerns the generation of docstrings from
25
25
the schema JSON in Plotly.js. Traces and
26
26
Layout classes have a direct correspondence with their Javascript
27
-
counterpart. Additional helper methods are defined there for the `Figure` object, such as
27
+
counterpart. Higher-level methods that work on on figures regardless of the current schema (e.g., `BaseFigure.for_each_trace`) are defined in `packages/python/plotly/plotly/basedatatypes.py`. Additional helper methods are defined there for the `Figure` object, such as
28
28
`update_layout`, `add_trace`, etc.
29
29
30
30
-[the `plotly.express` module](https://plotly.com/python/plotly-express/) (usually imported as `px`) is a high-level
31
-
functional API that uses `graph_objects` under the hood. Its code is in `packages/python/plotly/express`.
31
+
functional API that uses `graph_objects` under the hood. Its code is in `packages/python/plotly/express`.
32
32
Plotly Express functions
33
33
are designed to be highly consistent with each other, and to do *as little computation
34
34
in Python as possible*, generally concerning themselves with formatting data and creating
@@ -42,7 +42,7 @@ the structure of the code and of the repository.
42
42
43
43
-[the `plotly.figure_factory` module](https://plotly.com/python/figure-factories/) (usually imported as `ff`)
44
44
provides Python "recipes" for building
45
-
advanced visualizations with involved computation done in Python, such as
45
+
advanced visualizations with involved computation done in Python, such as
46
46
Hexbin maps, ternary contour plots, etc.
47
47
Figure factories are one of the easiest entry points into contributing to plotly.py, since
48
48
they consist of Python-only code, with standalone, well-separated functions.
0 commit comments