Skip to content
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

Import the part of PEP 566 about transforming core metadata to JSON #1466

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Copy link
Contributor

@sinoroc sinoroc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a topic I know about, but it seems fine to me, I do not see any reason to not merge this.

Comment on lines +877 to +879
.. [#json-not-interchange] This is not yet used as a standard interchange
format; the need for tools to work with years worth of existing packages
makes it difficult to shift to a new format.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this should be a warning note rather than a footnote.

It may be necessary to store metadata in a data structure which does not allow
for multiple repeated keys, such as JSON. This specification defines a way to
transform metadata into a JSON-compatible dictionary [#json-not-interchange]_.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simply stating the process seems a little sudden. Perhaps add the introduction from the PEP:

The canonical method to transform metadata fields into such a data structure is as follows:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants