Document that Requires-Dist can use explicit URLs #1783
Conversation
The core-metadata documentation currently implies that `Requires-Dist` can only use name-based specifiers, but then references PEP 508 which allows for URL based specifiers. Update the documentation to reflect this alternative specifier format.
|
This section should reference https://packaging.python.org/en/latest/specifications/dependency-specifiers/ rather PEP 508 directly. Any mention of direct URLs should point to their definition in https://packaging.python.org/en/latest/specifications/version-specifiers/#direct-references and note that they are not permitted on PyPI (but are fine for use in packages that are only uploaded to org specific index servers). The description of valid names should link to https://packaging.python.org/en/latest/specifications/name-normalization/#name-format |
|
I believe I've addressed all of your feedback @ncoghlan, please take another look |
| * An environment marker after a semicolon. This means that the | ||
| requirement is only needed in the specified conditions. | ||
|
|
||
| See :pep:`508` for full details of the allowed format. | ||
| See :ref:`dependency-specifiers` for full details of the allowed format. |
There was a problem hiding this comment.
It's rendered as capitalized by default:
| See :ref:`dependency-specifiers` for full details of the allowed format. | |
| See :ref:`dependency specifiers <dependency-specifiers>` for full details of the allowed format. |
| ``[extra1,extra2]``. These names are defined by the required | ||
| project, referring to specific features which may need extra | ||
| dependencies. The names MUST conform to the restrictions specified | ||
| by the ``Provides-Extra:`` field. |
There was a problem hiding this comment.
The core-metadata documentation currently implies that
Requires-Distcan only use name-based specifiers, but then references PEP 508 which allows for URL based specifiers. Update the documentation to reflect this alternative specifier format.📚 Documentation preview 📚: