description-content-type metadata field is not documented

[cmcginty]

I can't find any docs that explicitly state what the kwarg value for "description-content-type" is supposed to be. If I find it i'll close the ticket.

==========

long_description_content_type

I guess this is the value, but where are the docs for this?

setuptools/setuptools/dist.py

Line 63 in f012485

'long_description_content_type',

[xnuinside]

@cmcginty, http://setuptools.readthedocs.io/en/latest/setuptools.html#metadata - inside this doc info about type of this variable long_description_content_type

what is this, you can find here:
https://packaging.python.org/specifications/core-metadata/#description-content-type-optional (link to this page was provided inside #1075

[cmcginty]

Thanks for the links.

Setup tools has a description and long_description field, so I think it's still ambiguous that Description-Content-Type applies to long_description_content_type in setuptools. Can the setuptools docs be modified to link to PyPA packaging docs you provided?

IMO I think the PyPA distinction between summary and description is clear enough. Why does setuptools deviate from the PyPA guidelines? So now description sets the Summary: field and long_description sets the Description: field. Should I open another bug for this one?

[jaraco]

Can the setuptools docs be modified to link to PyPA packaging docs you provided?

Yes. Please send a PR.

Why does setuptools deviate from the PyPA guidelines?

Mainly for historical reasons. It probably evolved this way, refining the purpose as the use-cases were clarified. And while the naming in the metadata has evolved more rapidly, the API for Setuptools has evolved less so.

Should I open another bug for this one?

Perhaps, and especially if you wish to develop a PR to help transition the project from the current naming to a new one. The trick becomes doing that without breaking every build. There's probably a 2 year transition period where both names would need to be supported. If you have the patience for an effort like that, or have other ideas on how this change could be made with less trouble, then by all means, let's do it!

[brainwane]

A contributor added info in pypa/packaging.python.org#457 to https://packaging.python.org/tutorials/distributing-packages/ that may be helpful here.

[vitoace]

I will be working on it with Gene.

[genemat-zz]

Hi I'm Gene this is my first github project

[pganssle]

Was this fixed in 6b65f6b?

[jaraco]

That links to #1075.

[pganssle]

Closed in #1539