This is the old text.
Describing the distribution =========================== The distribution metadata should include a longer description of the distribution that may run to several paragraphs. Software that deals with metadata should not assume any maximum size for the description. The recommended location for the description is in the metadata payload, separated from the header fields by at least one completely blank line (that is, two successive line separators with no other characters between them, not even whitespace). Alternatively, the description may be provided in the `Description`__ metadata header field. Providing both a ``Description`` field and a payload is an error. __ `Description (optional, deprecated)`_ The distribution description can be written using reStructuredText markup [1]_. For programs that work with the metadata, supporting markup is optional; programs may also display the contents of the field as plain text without any special formatting. This means that authors should be conservative in the markup they use. On Tue, Jan 16, 2018 at 6:44 AM Thomas Kluyver <tho...@kluyver.me.uk> wrote: > Allow me to prod this topic again. ;-) > > I'm happy with PEP 566 as it stands. > > Do we want to specify 'email body is long description' in this PEP? It > appears to have at least some real world support, but I'm not familiar > enough with the email metadata format to write a proper description of it. > > Thanks, > Thomas > > On Fri, Jan 12, 2018, at 4:02 PM, Daniel Holth wrote: > > Yes, after the PEP is prep'd. > > On Fri, Jan 12, 2018 at 11:00 AM Alex Grönholm <alex.gronh...@nextday.fi> > wrote: > > On the same note, wheel currently writes "2.0" as its metadata version. > Shouldn't this be changed into 1.3 (along with ditching metadata.json)? > > > Thomas Kluyver kirjoitti 12.01.2018 klo 17:26: > > On Wed, Jan 10, 2018, at 11:42 PM, Nick Coghlan wrote: > >> On 11 January 2018 at 00:54, Daniel Holth <dho...@gmail.com> wrote: > >>> AFAICT the only missing feature from old-Metadata-2.0 is "description > as > >>> message body", which places readable description text after the > key/value > >>> pairs. > >> Do pip/PyPI/et al currently support that? > > It looks like twine supports it, at least for wheels: > > > https://github.com/pypa/twine/blob/f74eae5506300387572c65c9dbfe240d927788c2/twine/wheel.py#L99 > > > > I don't think pip needs to support it (does pip do anything with > descriptions?). I haven't looked at PyPI's code, but I'd guess it uses the > metadata sent with the upload by tools like twine and flit. > > > > Thomas > > _______________________________________________ > > Distutils-SIG maillist - Distutils-SIG@python.org > > https://mail.python.org/mailman/listinfo/distutils-sig > > _______________________________________________ > Distutils-SIG maillist - Distutils-SIG@python.org > https://mail.python.org/mailman/listinfo/distutils-sig > > *_______________________________________________* > Distutils-SIG maillist - Distutils-SIG@python.org > https://mail.python.org/mailman/listinfo/distutils-sig > > > _______________________________________________ > Distutils-SIG maillist - Distutils-SIG@python.org > https://mail.python.org/mailman/listinfo/distutils-sig >
_______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org https://mail.python.org/mailman/listinfo/distutils-sig
