-
Notifications
You must be signed in to change notification settings - Fork 933
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace some PEP references with internal references #1405
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -102,7 +102,7 @@ not only provides features that plain :ref:`distutils` doesn't offer | |
also provides a consistent build interface and feature set across all | ||
supported Python versions. | ||
|
||
Consequently, :ref:`distutils` was deprecated in Python 3.10 by :pep:`632` and | ||
Consequently, :ref:`distutils` was deprecated in Python 3.10 (by :pep:`632`) and | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note for myself: style change — parens. |
||
has been :doc:`removed <python:whatsnew/3.12>` from the standard library in | ||
Python 3.12. Setuptools bundles the standalone copy of distutils, and it is | ||
injected even on Python < 3.12 if you import setuptools first or use pip. | ||
|
@@ -523,7 +523,7 @@ pdm | |
`PyPI <https://pypi.org/project/pdm>`__ | ||
|
||
PDM is a modern Python package manager. It uses :term:`pyproject.toml` to store | ||
project metadata as defined in :pep:`621`. | ||
project metadata in the :ref:`[project] table <pyproject-project-table>`. | ||
|
||
.. _pex: | ||
|
||
|
@@ -665,7 +665,7 @@ shiv | |
`PyPI <https://pypi.org/project/shiv/>`__ | ||
|
||
shiv is a command line utility for building fully self contained | ||
Python zipapps as outlined in :pep:`441`, but with all their | ||
Python :doc:`zipapps <python:library/zipapp>`, with all their | ||
dependencies included. Its primary goal is making distributing Python | ||
applications and command line tools fast & easy. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -352,9 +352,8 @@ be ambiguous in the face of ``[project.scripts]`` and | |
``dependencies``/``optional-dependencies`` | ||
------------------------------------------ | ||
|
||
- TOML_ type: Array of :pep:`508` strings (``dependencies``), and a | ||
table with values of arrays of :pep:`508` strings | ||
(``optional-dependencies``) | ||
- TOML_ type: Array of strings (``dependencies``), and a | ||
table with values of arrays of strings (``optional-dependencies``) | ||
- Corresponding :ref:`core metadata <core-metadata>` field: | ||
:ref:`Requires-Dist <core-metadata-requires-dist>` and | ||
:ref:`Provides-Extra <core-metadata-provides-extra>` | ||
|
@@ -363,12 +362,13 @@ The (optional) dependencies of the project. | |
|
||
For ``dependencies``, it is a key whose value is an array of strings. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. (general contribution process feedback) Try not to reflow lines that don't change the content: it's hard to compare what changed, if an entire block of 13 lines is marked as updated — this causes an unnecessary cognitive load for the reviewers trying to compare strings byte-by-byte... This is the reason it's recommended to split the formatting changes from the functional ones in normal code projects, but I'm sure it's also applicable to the docs. Here's a collection of materials related to review processes, I enjoyed reading — maybe you'll find some insights for yourself too: |
||
Each string represents a dependency of the project and MUST be | ||
formatted as a valid :pep:`508` string. Each string maps directly to | ||
a :ref:`Requires-Dist <core-metadata-requires-dist>` entry. | ||
formatted as a valid :ref:`dependency specifier <dependency-specifiers>`. | ||
Each string maps directly to a :ref:`Requires-Dist <core-metadata-requires-dist>` entry. | ||
|
||
For ``optional-dependencies``, it is a table where each key specifies | ||
an extra and whose value is an array of strings. The strings of the | ||
arrays must be valid :pep:`508` strings. The keys MUST be valid values | ||
arrays must be valid :ref:`dependency specifiers <dependency-specifiers>`. | ||
The keys MUST be valid values | ||
for :ref:`Provides-Extra <core-metadata-provides-extra>`. Each value | ||
in the array thus becomes a corresponding | ||
:ref:`Requires-Dist <core-metadata-requires-dist>` entry for the | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note to myself: removed "most" + reflow.