diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-02-17 09:47:23 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-17 09:47:23 +0000 |
| commit | 041bbf078632d3557c6b54b516f4078a9fd4b092 (patch) | |
| tree | 1505c7842b709ded4bf40e226756952de72d5ace | |
| parent | b9bf2ec55106a7e77f603383c16450dea2f54c71 (diff) | |
| parent | 5774273a2eb9630fde2b8efd8458eb08db031562 (diff) | |
| download | python-setuptools-git-041bbf078632d3557c6b54b516f4078a9fd4b092.tar.gz | |
Document limitation of editable installs on docs (#3831)
Mention limitation in editable docs
| -rw-r--r-- | docs/userguide/development_mode.rst | 5 |
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** |