Commit f3b177e9 authored by Jason R. Coombs's avatar Jason R. Coombs

Update docstring to use imperative voice, provide a bit more context, and...

Update docstring to use imperative voice, provide a bit more context, and advise against copying of the behavior.
parent 384a5165
...@@ -86,10 +86,13 @@ class install_with_pth(install): ...@@ -86,10 +86,13 @@ class install_with_pth(install):
""" """
Custom install command to install a .pth file for distutils patching. 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 This hack is necessary because there's no standard way to install behavior
alongside your package (and there probably shouldn't be one), but we need on startup (and it's debatable if there should be one). This hack (ab)uses
to do this in order to give precedence higher precedence to our version of the `extra_path` behavior in Setuptools to install a `.pth` file with
`distutils` than the standard library. 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' _pth_name = 'distutils-precedence'
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment