Skip to content

Commit 0c106bf

Browse files
committed
Update docs to clarify dangling list
1 parent e2180b2 commit 0c106bf

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/userguide/declarative_config.rst

+9-8
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ Key Type Minimum Version No
228228
======================= =================================== =============== ====================
229229
zip_safe bool
230230
setup_requires list-semi 36.7.0
231-
install_requires file:, list-semi **BETA** [#opt-6]_
231+
install_requires file:, list-semi **BETA** [#opt-2]_, [#opt-6]_
232232
extras_require file:, section **BETA** [#opt-2]_, [#opt-6]_
233233
python_requires str 34.4.0
234234
entry_points file:, section 51.0.0
@@ -251,17 +251,18 @@ data_files section 40.6.0 [#
251251
.. [#opt-1] In the ``package_data`` section, a key named with a single asterisk
252252
(``*``) refers to all packages, in lieu of the empty string used in ``setup.py``.
253253
254-
.. [#opt-2] In the ``extras_require`` section, values are parsed as ``list-semi``.
255-
This implies that in order to include markers, they **must** be *dangling*:
254+
.. [#opt-2] In ``install_requires`` and ``extras_require``, values are parsed as ``list-semi``.
255+
This implies that in order to include markers, each requirement **must** be *dangling*
256+
in a new line:
256257
257258
.. code-block:: ini
259+
[options]
260+
install_requires =
261+
importlib-metadata; python_version<"3.8"
258262
259263
[options.extras_require]
260-
rest = docutils>=0.3; pack ==1.1, ==1.3
261-
pdf =
262-
ReportLab>=1.2
263-
RXP
264-
importlib-metadata; python_version < "3.8"
264+
all =
265+
importlib-metadata; python_version < "3.8"
265266
266267
.. [#opt-3] The ``find:`` and ``find_namespace:`` directive can be further configured
267268
in a dedicated subsection ``options.packages.find``. This subsection accepts the

0 commit comments

Comments
 (0)