-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Conversation
f21e45d
to
1de3148
Compare
ping! markdown readme's would be great to have |
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? |
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
1de3148
to
1ca7ade
Compare
1ca7ade
to
bf1f964
Compare
@jaraco I added an entry to I didn't really see anywhere where the documentation goes in-depth about 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. |
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.