PEP 639: minor edits for clarity and consistency #3921
Conversation
|
All commit authors signed the Contributor License Agreement. |
| and one or more ``License-File`` fields is specified, the ``.dist-info`` | ||
| and one or more ``License-File`` fields is specified, the installed ``.dist-info`` | ||
| directory MUST contain a ``licenses`` subdirectory which MUST contain | ||
| the files listed in the ``License-File`` fields in the ``METADATA`` file | ||
| at their respective paths relative to the ``licenses`` directory, | ||
| and that any files in this directory MUST be copied from wheels | ||
| by install tools. | ||
| at their respective paths relative to the ``licenses`` directory. |
There was a problem hiding this comment.
The clause "and that any files in this directory MUST be copied from wheels by install tools" has two potential interpretations:
- Files declared via the
License-FileCore Metadata field in the wheel distribution MUST be copied into this directory. This isn't wrong, but it is redundant with the earlier text. Simply stating that we're talking about the installed.dist-infodirectory should suffice IMO. - Only files declared in the
License-FileCore Metadata field are permitted to be in this directory. If this is the case, I'd suggest adding the word "only" somewhere.
I initially read the line under the second interpretation, but that seems wrong? I'd appreciate your thoughts @befeleme.
There was a problem hiding this comment.
Since I'm not the original author, let me provide another interpretation - how I see it: PEP doesn't specify nor forbid what else, except for the files listed under the License-File fields can be listed in the .dist-info/licenses directory, but it ensures that whatever is there (e.g. filled in by a build backend custom means), will always be installed with the copies of the software. Hence the partial redundancy of the wording.
| - The appendix :ref:`639-spec-mapping-classifiers-identifiers` provides | ||
| - The :ref:`639-spec-mapping-classifiers-identifiers` provides |
There was a problem hiding this comment.
When the reference is rendered, the word "appendix" appears twice.
The main substantive edits are: - Removing references to the `license-files.globs` and `license-files.paths` fields that no longer exist in the current draft - Shortening the summary of changes to the recording installed distributions specification by removing a redundant (implied) clause
|
cc @befeleme |
ichard26
force-pushed
the
copyedit-pep639
branch
from
8c8784e to
bffa6a5
Compare
|
I don't have the interest in going through the formal process to amend a PEP so I'll close this. |
While reading the draft PEP 639, there were a few parts which read poorly and could be easily improved. There were also a few obvious typos.
The main substantive edits are:
license-files.globsandlicense-files.pathsfields that no longer exist in the current draft📚 Documentation preview 📚: https://pep-previews--3921.org.readthedocs.build/