Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d58495e

Browse files
committed
PEP 685: Update headers & fix reST syntax, links & punctuation
1 parent 13aa4b1 commit d58495e

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

pep-0685.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Status: Draft
77
Type: Standards Track
88
Content-Type: text/x-rst
99
Created: 08-Mar-2022
10-
Post-History: 08-Mar-2022
10+
Post-History: `08-Mar-2022 <https://discuss.python.org/t/14141>`__
1111

1212

1313
Abstract
@@ -64,10 +64,10 @@ Runs of ``.`` and ``-``, unlike PEP 503, do **not** get collapsed,
6464
e.g. ``..`` stays the same.
6565

6666
For pip 22, its
67-
"extra normalisation behaviour is quite convoluted and erratic" [pip-erratic]_,
67+
`"extra normalisation behaviour is quite convoluted and erratic" <pip-erratic_>`__,
6868
and so its use is not considered.
6969

70-
.. [pip-erratic] https://discuss.python.org/t/what-extras-names-are-treated-as-equal-and-why/7614/10?
70+
.. _pip-erratic: https://discuss.python.org/t/7614/10
7171

7272

7373
Specification
@@ -99,7 +99,7 @@ tools SHOULD warn the user.
9999
Tools SHOULD warn users when an invalid extra name is read and not use
100100
the name to avoid ambiguity.
101101
Tools MAY raise an error instead of a warning when reading an
102-
invalid name if they so desire.
102+
invalid name, if they so desire.
103103

104104

105105
Backwards Compatibility
@@ -108,20 +108,20 @@ Backwards Compatibility
108108
Moving to :pep:`503` normalization and :pep:`508` name acceptance, it
109109
allows for all preexisting, valid names to continue to be valid.
110110

111-
Based on research looking at a collection of wheels on PyPI [pypi-results]_,
111+
Based on `research looking at a collection of wheels on PyPI <pypi-results_>`__,
112112
the risk of extra name clashes is limited to 73 clashes when considering
113113
even invalid names,
114114
while *only* looking at valid names leads to only 3 clashes:
115115

116-
1. dev-test: dev_test, dev-test, dev.test
117-
2. dev-lint: dev-lint, dev.lint, dev_lint
118-
3. apache-beam: apache-beam, apache.beam
116+
* ``dev-test``: ``dev_test``, ``dev-test``, ``dev.test``
117+
* ``dev-lint``: ``dev-lint``, ``dev.lint``, ``dev_lint``
118+
* ``apache-beam``: ``apache-beam``, ``apache.beam``
119119

120120
By requiring tools writing core metadata to only record the normalized name,
121121
the issue of preexisting, invalid extra names should be diminished over
122122
time.
123123

124-
.. [pypi-results] https://discuss.python.org/t/pep-685-comparison-of-extra-names-for-optional-distribution-dependencies/14141/17?u=brettcannon
124+
.. _pypi-results: https://discuss.python.org/t/14141/17
125125

126126

127127
Security Implications
@@ -162,7 +162,7 @@ Rejected Ideas
162162
Using setuptools 60's normalization
163163
-----------------------------------
164164

165-
Initially this PEP proposed following setuptools to try and minimize
165+
Initially, this PEP proposed following setuptools to try to minimize
166166
backwards-compatibility issues.
167167
But after checking various wheels on PyPI,
168168
it became clear that standardizing **all** naming on :pep:`508` and

0 commit comments

Comments
 (0)