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

Add new long_description_content_type kwarg #1075

Merged
merged 5 commits into from
Sep 3, 2017

Conversation

di
Copy link
Sponsor Member

@di di commented Jul 3, 2017

This is a re-opening of #708 which was closed.

Since then, pypa/packaging.python.org#258 has been merged and is now documented here: https://packaging.python.org/specifications/#description-content-type

I've rebased it and amended the commit messages to reflect that pypa/packaging.python.org#258 was accepted.

@coilysiren
Copy link

ping! markdown readme's would be great to have

@jaraco
Copy link
Member

jaraco commented Aug 26, 2017

Looks good. Can you just add a CHANGES.txt entry notifying users of what's changed and how they can use it? Also, are there relevant docs changes that need to address this functionality?

msabramo and others added 3 commits August 28, 2017 12:32
This is used to populate the new `Description-Content-Type` field.

`Description-Content-Type` is described at
pypa/packaging.python.org#258
Test that specifying a `long_description_content_type` keyword arg to
the `setup` function results in writing a `Description-Content-Type`
line to the `PKG-INFO` file in the `<distribution>.egg-info` directory.

`Description-Content-Type` is described at
pypa/packaging.python.org#258
@di di force-pushed the long_description_content_type branch from 1de3148 to 1ca7ade Compare August 28, 2017 18:11
@di di force-pushed the long_description_content_type branch from 1ca7ade to bf1f964 Compare August 28, 2017 18:16
@di
Copy link
Sponsor Member Author

di commented Aug 28, 2017

@jaraco I added an entry to CHANGES.rst and updated a table in the docs which lists the available fields.

I didn't really see anywhere where the documentation goes in-depth about long_description where it felt appropriate to add more explanation about long_description_content_type, but if you feel there is a place, I am happy to add it.

It might be worth mentioning here (but not in the docs) that until this is implemented in pypa/readme_renderer, this field will not actually be very useful to the user.

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.

None yet

4 participants