Skip to content
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

Jump to bottom

[Doc] Correct the note about dev installation #3289

Merged
merged 2 commits into from
Oct 27, 2021
+4 −4
Merged

[Doc] Correct the note about dev installation #3289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f65dcc7
[Doc] Explain the different modes of setup.py more clearly
sjwsl Oct 26, 2021
219979b
Update docs/lang/articles/contribution/dev_install.md
sjwsl Oct 27, 2021
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
8 changes: 4 additions & 4 deletions docs/lang/articles/contribution/dev_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,10 @@ shipped with .NET).
:::note
`python setup.py develop` command (recommended for developers) works very similarly to
`setup.py install` command (recommended for users) except
that it doesn't actually install anything. It fits developer need better since edits
on python file take effect immediately without rebuilding. You only need to rerun `develop`
commands when you change a project’s C extensions or similarly compiled files. See
[development mode](https://setuptools.pypa.io/en/stable/userguide/development_mode.html) for more details.
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
on python files take effect immediately without rebuilding. You only need to rerun `develop`
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.
See [development mode](https://setuptools.pypa.io/en/stable/userguide/development_mode.html) for more details.
:::

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