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

Projects
None yet
4 participants
@di
Copy link
Member

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.

@msabramo msabramo referenced this pull request Jul 3, 2017

Closed

Add Markdown support #3

@di di force-pushed the di:long_description_content_type branch from f21e45d to 1de3148 Jul 24, 2017

@lynncyrin

This comment has been minimized.

Copy link

lynncyrin commented Aug 4, 2017

ping! markdown readme's would be great to have

@jaraco

This comment has been minimized.

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 some commits Jul 30, 2016

Add new long_description_content_type kwarg
This is used to populate the new `Description-Content-Type` field.

`Description-Content-Type` is described at
pypa/packaging.python.org#258
Add test_long_description_content_type
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 di:long_description_content_type branch from 1de3148 to 1ca7ade Aug 28, 2017

@di di force-pushed the di:long_description_content_type branch from 1ca7ade to bf1f964 Aug 28, 2017

@di

This comment has been minimized.

Copy link
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.

@jaraco jaraco merged commit 09e14c7 into pypa:master Sep 3, 2017

0 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

@ghost ghost referenced this pull request Sep 3, 2017

Closed

dist_info: implement command #190

@di di deleted the di:long_description_content_type branch Sep 12, 2017

nocarryr added a commit to nocarryr/pyrtlsdr that referenced this pull request Oct 2, 2017

@scls19fr scls19fr referenced this pull request May 11, 2018

Merged

no setuptools-markdown #68

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.