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

Skip to content

Commit 5df126f

Browse files
Clarified installation process for development
Included the words "install from source" and links to documentation on pip -e and setuptool's "developer mode".
1 parent 3c1a7d1 commit 5df126f

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

contributing.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ the structure of the code and of the repository.
6464
https://github.com/plotly/plotly.py/issues/1965. If you have writing skills,
6565
the wording of existing examples can also be improved in places.
6666

67-
Contributing code or documentation are not the only way to contribute! You can
67+
Contributing code or documentation is not the only way to contribute! You can
6868
also contribute to the project by
6969

7070
- reporting bugs (see below).
@@ -133,15 +133,20 @@ conda activate plotly-dev
133133
$ pip install -r packages/python/plotly/requirements.txt
134134
$ pip install -r packages/python/plotly/optional-requirements.txt
135135

136-
### Editable install of plotly packages
136+
### Editable install of plotly packages (install from source)
137137

138138
$ pip install -e packages/python/plotly/
139139
$ pip install -e packages/python/chart-studio/
140140
$ pip install -e packages/python/plotly-geo/
141141

142-
This will ensure that the installed packages links to your local development
142+
This will ensure that the installed packages link to your local development
143143
directory, meaning that all changes you make reflect directly in your
144-
environment (don't forget to restart the Jupyter kernel though!).
144+
environment (don't forget to restart the Jupyter kernel though!). For more
145+
information see the
146+
[`setuptools`](https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode)
147+
and
148+
[`pip`](https://pip.pypa.io/en/stable/reference/pip_install/#install-editable)
149+
documentation on _development mode_.
145150

146151
### ipywidgets development install
147152

0 commit comments

Comments
 (0)