Skip to content

Commit 3c30e58

Browse files
sjwslstrongoier
andauthored
[Doc] Correct the note about dev installation (#3289)
* [Doc] Explain the different modes of setup.py more clearly * Update docs/lang/articles/contribution/dev_install.md Co-authored-by: Yi Xu <[email protected]> Co-authored-by: Yi Xu <[email protected]>
1 parent 3576a24 commit 3c30e58

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/lang/articles/contribution/dev_install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,10 @@ shipped with .NET).
135135
:::note
136136
`python setup.py develop` command (recommended for developers) works very similarly to
137137
`setup.py install` command (recommended for users) except
138-
that it doesn't actually install anything. It fits developer need better since edits
139-
on python file take effect immediately without rebuilding. You only need to rerun `develop`
140-
commands when you change a projects C extensions or similarly compiled files. See
141-
[development mode](https://setuptools.pypa.io/en/stable/userguide/development_mode.html) for more details.
138+
that it doesn't actually install anything, but only adds a symbolic link in the deployment directory that links to the source code. It fits developers' needs better since edits
139+
on python files take effect immediately without rebuilding. You only need to rerun `develop`
140+
commands when you modify a project's C extensions or similarly compiled files. In comparison `install` deep copies the source code so you need to rerun it after any modification.
141+
See [development mode](https://setuptools.pypa.io/en/stable/userguide/development_mode.html) for more details.
142142
:::
143143

144144
2. Check out the `examples` folder for runnable examples. Run them with commands

0 commit comments

Comments
 (0)