summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2023-02-15 19:40:46 +0000
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2023-02-17 09:22:49 +0000
commit5774273a2eb9630fde2b8efd8458eb08db031562 (patch)
tree1505c7842b709ded4bf40e226756952de72d5ace /docs/userguide
parentb9bf2ec55106a7e77f603383c16450dea2f54c71 (diff)
downloadpython-setuptools-git-5774273a2eb9630fde2b8efd8458eb08db031562.tar.gz
Mention limitation in editable docs
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/development_mode.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/userguide/development_mode.rst b/docs/userguide/development_mode.rst
index 12d50fbc..6a4b04a7 100644
--- a/docs/userguide/development_mode.rst
+++ b/docs/userguide/development_mode.rst
@@ -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**