Skip to content

Commit 5774273

Browse files
committed
Mention limitation in editable docs
1 parent b9bf2ec commit 5774273

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/userguide/development_mode.rst

+5
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,11 @@ Limitations
159159
whose names coincidentally match installed packages
160160
may take precedence in :doc:`Python's import system <python:reference/import>`.
161161
Users are encouraged to avoid such scenarios [#cwd]_.
162+
- Setuptools will try to give the right precedence to modules in an editable install.
163+
However this is not always an easy task. If you have a particular order in
164+
``sys.path`` or some specific import precedence that needs to be respected,
165+
the editable installation as supported by Setuptools might not be able to
166+
fulfil this requirement, and therefore it might not be the right tool for your use case.
162167

163168
.. attention::
164169
Editable installs are **not a perfect replacement for regular installs**

0 commit comments

Comments
 (0)