Skip to content

Commit 98e7929

Browse files
ewdurbinwarsaw
andauthored
Apply suggestions from code review
Co-authored-by: Barry Warsaw <barry@python.org>
1 parent b7d8ac5 commit 98e7929

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

peps/pep-0694.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Abstract
1717
This PEP proposes an extensible API for uploading files to a Python package index such as PyPI.
1818
Along with standardization, the upload API provides additional useful features such as support for:
1919

20-
* an publishing session, which can be used to simultaneously publish
20+
* a publishing session, which can be used to simultaneously publish
2121
all wheels in a package release;
2222

2323
* "staging" a release, which can be used to test uploads before publicly publishing them,
@@ -620,7 +620,7 @@ Besides the standard ``meta`` key, the request JSON has the following additional
620620
This mechanism **SHOULD** be chosen from the list of mechanisms advertised in the
621621
:ref:`Publishing Session response body <publishing-session-response>`.
622622
A client **MAY** send a mechanism that is not advertised in cases where server operators have
623-
documented a new or up-coming mechanism that is available for use on a "pre-release" basis.
623+
documented a new or upcoming mechanism that is available for use on a "pre-release" basis.
624624

625625
``metadata`` (**optional**)
626626
If given, this is a string value containing the file's `core metadata
@@ -684,7 +684,7 @@ the following keys:
684684
A mapping containing the necessary details for the supported mechanism
685685
as negotiated by the client and server.
686686
This mapping **MUST** contain a key ``identifier`` which maps to
687-
the identifier string for the File Upload Mechanism.
687+
the identifier string for the chosen File Upload Mechanism.
688688

689689
.. _file-upload-session-links:
690690

@@ -747,7 +747,7 @@ A client can cancel an in-progress File Upload Session, or delete a file that ha
747747
completely uploaded. In both cases, the client performs this by issuing a ``DELETE`` request to
748748
the File Upload Session URL of the file they want to delete.
749749

750-
A successful deletion request **MUST** response with a ``204 No Content``.
750+
A successful deletion request **MUST** respond with a ``204 No Content``.
751751

752752
Once canceled or deleted, a client **MUST NOT** assume that
753753
the previous File Upload Session resource
@@ -841,11 +841,11 @@ The ``stage`` URL can be passed to installers such as ``pip`` by setting the `--
841841
<https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-extra-index-url>`__ flag to this value.
842842
Multiple stages can even be previewed by repeating this flag with multiple values.
843843

844-
In either case, the index will return views that expose the staged releases to the installer tool,
844+
If supported, the index will return views that expose the staged releases to the installer tool,
845845
making them available to download and install into virtual environments built for that last-mile
846-
testing. The former option allows for existing installers to preview staged releases with no
847-
changes, although perhaps in a less user-friendly way. The latter option can be a better user
848-
experience, but the details of this are left to installer tool maintainers.
846+
testing. This option allows existing installers to preview staged releases with no
847+
changes to the installer tool required.
848+
The details of this user experience are left to installer tool maintainers.
849849

850850

851851
.. _file-upload-mechanisms:
@@ -870,6 +870,8 @@ Required File Upload Mechanisms
870870
``http-post-bytes``
871871
+++++++++++++++++++
872872

873+
Upload API version 2.0 compliant servers **MUST** support the ``http-post-bytes`` mechanism.
874+
873875
A client executes this mechanism by submitting a ``POST`` request to the ``file_url``
874876
returned in the ``http-post-bytes`` map of the ``mechanism`` map of the
875877
:ref:`File Upload Session creation response body <file-upload-session-response>` like:
@@ -930,7 +932,7 @@ File Upload Mechanism string Server Operator Mechanism description
930932
``vnd-madscience-quantumentanglement`` Mad Science Labs Upload via quantum entanglement
931933
====================================== ================ =========================================================================
932934

933-
If a server intends to match the behavior of another server's implementation, it **MAY** respond
935+
If a server intends to precisely match the behavior of another server's implementation, it **MAY** respond
934936
with that implementation's file upload mechanism name.
935937

936938

0 commit comments

Comments
 (0)