aboutsummaryrefslogtreecommitdiffstats
path: root/setup.py
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2020-07-26 10:42:15 -0400
committerJason R. Coombs <jaraco@jaraco.com>2020-07-26 10:42:15 -0400
commitf3b177e9c2b77104ddebaec7b581e2aee73a1184 (patch)
treedc47e42fe4ab5642db2bde83fdf464b4802f3840 /setup.py
parent384a51657c94271d29c437415080f25f7df4103b (diff)
downloadexternal_python_setuptools-f3b177e9c2b77104ddebaec7b581e2aee73a1184.tar.gz
external_python_setuptools-f3b177e9c2b77104ddebaec7b581e2aee73a1184.tar.bz2
external_python_setuptools-f3b177e9c2b77104ddebaec7b581e2aee73a1184.zip
Update docstring to use imperative voice, provide a bit more context, and advise against copying of the behavior.
Diffstat (limited to 'setup.py')
-rwxr-xr-xsetup.py11
1 files changed, 7 insertions, 4 deletions
diff --git a/setup.py b/setup.py
index edb2bbcf..45ddb149 100755
--- a/setup.py
+++ b/setup.py
@@ -86,10 +86,13 @@ class install_with_pth(install):
"""
Custom install command to install a .pth file for distutils patching.
- This is necessary because there's no standard way to install a `.pth` file
- alongside your package (and there probably shouldn't be one), but we need
- to do this in order to give precedence higher precedence to our version of
- `distutils` than the standard library.
+ This hack is necessary because there's no standard way to install behavior
+ on startup (and it's debatable if there should be one). This hack (ab)uses
+ the `extra_path` behavior in Setuptools to install a `.pth` file with
+ implicit behavior on startup to give higher precedence to the local version
+ of `distutils` over the version from the standard library.
+
+ Please do not replicate this behavior.
"""
_pth_name = 'distutils-precedence'