summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoralvy <alvyjudy@gmail.com>2020-07-29 22:08:52 -0400
committeralvy <alvyjudy@gmail.com>2020-07-29 22:08:52 -0400
commitdee83be182df63d05f4a1d52639c61f34b64234f (patch)
tree76dc92155431cebefa133c066793ee4cdd4a6d90 /docs
parent5df7ee405dc7455b842daa82989d199689d8650e (diff)
downloadpython-setuptools-git-dee83be182df63d05f4a1d52639c61f34b64234f.tar.gz
docs: rephrased the introduction for optional dependencies
note the use case for tests and docs functions and that "test_require" is deprecated, shorten description of the example
Diffstat (limited to 'docs')
-rw-r--r--docs/userguide/dependency_management.txt14
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/userguide/dependency_management.txt b/docs/userguide/dependency_management.txt
index 50f061c9..a26ab6c3 100644
--- a/docs/userguide/dependency_management.txt
+++ b/docs/userguide/dependency_management.txt
@@ -199,12 +199,16 @@ distributions, if the package's dependencies aren't already installed:
Optional dependencies
=====================
Setuptools allows you to declare dependencies that only get installed under
-specific circumstances. For example, let's say that Project-A offers optional
-PDF support and requires some additional package for it to work. Such a
-dependency will be specified with ``extras_require`` keyword and they are only
-installed if another package depends on it (either directly or indirectly).
+specific circumstances. These dependencies are specified with ``extras_require``
+keyword and are only installed if another package depends on it (either
+directly or indirectly) This makes it convenient to declare dependencies for
+ancillary functions such as "tests" and "docs".
-Let's first see how to specify such package:
+.. note::
+ ``tests_require`` is now deprecated
+
+For example, Package-A offers optional PDF support and requires two other
+dependencies for it to work:
.. code-block:: ini