Skip to content

Repair and clean metadata#304

Merged
jaraco merged 14 commits intomainfrom
repaired-clean-metadata
Apr 18, 2021
Merged

Repair and clean metadata#304
jaraco merged 14 commits intomainfrom
repaired-clean-metadata

Conversation

@jaraco
Copy link
Copy Markdown
Member

@jaraco jaraco commented Apr 18, 2021

Superseding #301 and #303, update the PackageMetadata protocol thus:

  • Always provide a Description (even if found in the payload).
  • Support multiline values for any field, even though the spec or build tools may still disallow it.
  • For any multiline values, remove the line-continuation characters.
  • Add a json property that converts the metadata into a JSON-compatible format per PEP 566.

Fixes #275, Fixes #276, Fixes #277.

@jaraco
Copy link
Copy Markdown
Member Author

jaraco commented Apr 18, 2021

Technically, this proposed change is a backward-incompatible one. Any projects that are depending on Description having line continuation indents will find that it doesn't now. This change actually manifest as a bug in pytest-checkdocs, fixed by jaraco/pytest-checkdocs@74d70d4.

@jaraco jaraco force-pushed the repaired-clean-metadata branch from f824051 to c8b753e Compare April 18, 2021 14:30
@jaraco jaraco merged commit 615044d into main Apr 18, 2021
@jaraco jaraco deleted the repaired-clean-metadata branch April 18, 2021 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support JSON encoding of metadata Support loading of multi-line fields Description not available through PackageMetadata protocol

1 participant