From 5774273a2eb9630fde2b8efd8458eb08db031562 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Wed, 15 Feb 2023 19:40:46 +0000 Subject: [PATCH] Mention limitation in editable docs --- docs/userguide/development_mode.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/userguide/development_mode.rst b/docs/userguide/development_mode.rst index 12d50fbc93..6a4b04a7ad 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 `. 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**