Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Clarified where to find higher-level functions on figures #2724

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.

Sign up for GitHub

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 1 commit into from
Aug 24, 2020
Merged

Clarified where to find higher-level functions on figures #2724

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ the structure of the code and of the repository.

- [the `plotly.graph_objects` module](https://plotly.com/python/graph-objects/) (usually imported as `go`)
is [generated from the Plotly.js schema](https://plotly.com/python/figure-structure/),
so changes to be made in this package need to be
[contributed to Plotly.js](https://github.com/plotly/plotly.js) or to the `codegen` system
so changes to be made in this package need to be
[contributed to Plotly.js](https://github.com/plotly/plotly.js) or to the `codegen` system
in `packages/python/plotly/codegen`. Most of the codegen code concerns the generation of docstrings from
the schema JSON in Plotly.js. Traces and
Layout classes have a direct correspondence with their Javascript
counterpart. Additional helper methods are defined there for the `Figure` object, such as
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
`update_layout`, `add_trace`, etc.

- [the `plotly.express` module](https://plotly.com/python/plotly-express/) (usually imported as `px`) is a high-level
functional API that uses `graph_objects` under the hood. Its code is in `packages/python/plotly/express`.
functional API that uses `graph_objects` under the hood. Its code is in `packages/python/plotly/express`.
Plotly Express functions
are designed to be highly consistent with each other, and to do *as little computation
in Python as possible*, generally concerning themselves with formatting data and creating
Expand All @@ -42,7 +42,7 @@ the structure of the code and of the repository.

- [the `plotly.figure_factory` module](https://plotly.com/python/figure-factories/) (usually imported as `ff`)
provides Python "recipes" for building
advanced visualizations with involved computation done in Python, such as
advanced visualizations with involved computation done in Python, such as
Hexbin maps, ternary contour plots, etc.
Figure factories are one of the easiest entry points into contributing to plotly.py, since
they consist of Python-only code, with standalone, well-separated functions.
Expand Down Expand Up @@ -140,7 +140,7 @@ conda activate plotly-dev
```bash
(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
```
```
### Install requirements - (Windows + Conda)
Because Windows requires Visual Studio libraries to compile some of the optional dependencies, follow these steps to
complete installation and avoid gdal-config errors.
Expand Down