Skip to content

Commit

Permalink
Document limitation of editable installs on docs (#3831)
Browse files Browse the repository at this point in the history
Mention limitation in editable docs
  • Loading branch information
abravalheri authored Feb 17, 2023
2 parents b9bf2ec + 5774273 commit 041bbf0
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/userguide/development_mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,11 @@ Limitations
whose names coincidentally match installed packages
may take precedence in :doc:`Python's import system <python:reference/import>`.
Users are encouraged to avoid such scenarios [#cwd]_.
- Setuptools will try to give the right precedence to modules in an editable install.
However this is not always an easy task. If you have a particular order in
``sys.path`` or some specific import precedence that needs to be respected,
the editable installation as supported by Setuptools might not be able to
fulfil this requirement, and therefore it might not be the right tool for your use case.

.. attention::
Editable installs are **not a perfect replacement for regular installs**
Expand Down

0 comments on commit 041bbf0

Please sign in to comment.