Skip to content

Commit 9b92ec8

Browse files
Clarified where to find higher-level functions on figures
1 parent 445290a commit 9b92ec8

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

contributing.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ the structure of the code and of the repository.
1919

2020
- [the `plotly.graph_objects` module](https://plotly.com/python/graph-objects/) (usually imported as `go`)
2121
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
2424
in `packages/python/plotly/codegen`. Most of the codegen code concerns the generation of docstrings from
2525
the schema JSON in Plotly.js. Traces and
2626
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
2828
`update_layout`, `add_trace`, etc.
2929

3030
- [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`.
3232
Plotly Express functions
3333
are designed to be highly consistent with each other, and to do *as little computation
3434
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.
4242

4343
- [the `plotly.figure_factory` module](https://plotly.com/python/figure-factories/) (usually imported as `ff`)
4444
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
4646
Hexbin maps, ternary contour plots, etc.
4747
Figure factories are one of the easiest entry points into contributing to plotly.py, since
4848
they consist of Python-only code, with standalone, well-separated functions.
@@ -140,7 +140,7 @@ conda activate plotly-dev
140140
```bash
141141
(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
142142
(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
143-
```
143+
```
144144
### Install requirements - (Windows + Conda)
145145
Because Windows requires Visual Studio libraries to compile some of the optional dependencies, follow these steps to
146146
complete installation and avoid gdal-config errors.

0 commit comments

Comments
 (0)