[Distutils] Immutability of Release Metadata in Warehouse
ncoghlan at gmail.com
Mon Dec 25 18:18:41 EST 2017
On 20 December 2017 at 05:58, Donald Stufft <donald at stufft.io> wrote:
> However! There is a desire to enable Markdown support for PyPI, and as part
> of that a new metadata field is being added that just indicates what format
> the description is in (rst, markdown, or plaintext is the supported ones
> once that field gets added). Once we get that field added and plumbed
> through, then we’ll have a mechanism by which we can determine if the field
> is supposed to render correctly, and the plan is to start rejecting uploads
> that include that field (the behavior if that field isn’t included would be
> the current behavior) where the description does not correctly render with
> the selected technology.
The Description-Content-Type field has been added to the spec:
(This was part of the motivation for Dustin's metadata 1.3 PEP, to
help make it more readily apparent that we'd added that)
So the missing step is the "plumbing through" part, such that the
publishing tools support setting it, and Warehouse supports ensuring
the description renders at upload time.
However, there's still a difference between "renders without error"
and "renders the way the developer intended", so your initial post
will still stand for those kinds of problems (as well as typo fixes,
Nick Coghlan | ncoghlan at gmail.com | Brisbane, Australia
More information about the Distutils-SIG