Skip to content

Commit 2ce4d07

Browse files
committed
Remove some duplication in "Provider information"
Environment marker usage and optionality is described in "Providers" section. Let's limit "Provider information" only to technical field details themselves. Signed-off-by: Michał Górny <mgorny@quansight.com>
1 parent a2d653d commit 2ce4d07

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

peps/pep-0817.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1455,21 +1455,15 @@ A provider information dictionary MAY contain the following keys:
14551455

14561456
- ``enable-if: str``: An :ref:`environment marker
14571457
<dependency-specifiers-environment-markers>` defining when the plugin
1458-
should be used. If the environment marker does not match the running
1459-
environment, the provider will be disabled and the variants using its
1460-
properties will be deemed incompatible. If not provided, the plugin
1461-
will be used in all environments.
1458+
should be used.
14621459

14631460
- ``install-time: bool``: Whether this is an install-time provider.
14641461
Defaults to ``true``. ``false`` means that it is an AoT provider
14651462
instead.
14661463

14671464
- ``optional: bool``: Whether the provider is optional. Defaults
14681465
to ``false``. If it is ``true``, the provider is
1469-
considered optional and SHOULD NOT be used unless the user opts in to
1470-
it, effectively rendering the variants using its properties
1471-
incompatible. If it is ``false``, the provider is considered
1472-
obligatory.
1466+
considered optional.
14731467

14741468
- ``plugin-api: str``: The API endpoint for the plugin. If it is
14751469
specified, it MUST be an object reference as explained in the `API

0 commit comments

Comments
 (0)