Skip to content

Commit

Permalink
Replace incorrect statement about triggering installation of dependen…
Browse files Browse the repository at this point in the history
…cies to indicate that the handling is mostly implementation specific. Ref #1471.
  • Loading branch information
jaraco committed Dec 28, 2020
1 parent 2878bad commit c657e82
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/userguide/dependency_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ When your project is installed (e.g. using pip), all of the dependencies not
already installed will be located (via PyPI), downloaded, built (if necessary),
and installed and 2) Any scripts in your project will be installed with wrappers
that verify the availability of the specified dependencies at runtime.


Platform specific dependencies
------------------------------
Expand Down Expand Up @@ -202,7 +202,7 @@ Optional dependencies
Setuptools allows you to declare dependencies that only get installed under
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
directly or indirectly) This makes it convenient to declare dependencies for
ancillary functions such as "tests" and "docs".

.. note::
Expand Down Expand Up @@ -262,8 +262,12 @@ First is the console_scripts entry point:
}
)
When the script ``rst2pdf`` is run, it will trigger the installation of
the two dependencies ``PDF`` maps to.
This syntax indicates that the entry point (in this case a console script)
is only valid when the PDF extra is installed. It is up to the installer
to determine how to handle the situation where PDF was not indicated
(e.g. omit the console script, provide a warning when attempting to load
the entry point, assume the extras are present and let the implementation
fail later).

The second use case is that other package can use this "extra" for their
own dependencies. For example, if "Project-B" needs "project A" with PDF support
Expand Down

0 comments on commit c657e82

Please sign in to comment.