Added long_description_content_type #457
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With [PEP 566](https://www.python.org/dev/peps/pep-0566/#description-content-type-optional), the `long_description` can be Markdown with the `long_description_content_type` arg. This adds documentation for it There were also a couple cases where filenames were enclosed with quotes rather than as code; I've changed those to be `code` as well for consistency. See also: * [Relevant section in PEP 566](https://www.python.org/dev/peps/pep-0566/#description-content-type-optional) * [The CommonMark specification](http://spec.commonmark.org) * [The Description-Content-Type field documentation in the Python packaging documentation](https://packaging.python.org/specifications/core-metadata/#description-content-type-optional)
brainwane
reviewed
Mar 18, 2018
There was a problem hiding this comment.
Heads-up if you'd like to be particularly fancy with your Sphinx/rST markup here: the :file: syntax might be a cool choice here for, e.g., setup.py and setup.cfg. Using :file: makes it possible for this documentation to someday format filenames in some special way. Which I think is cool. (This is in no way a "you must do this" criticism.)
theacodes
approved these changes
Mar 18, 2018
|
@brainwane the |
|
Thanks, @9999years! |
|
Great! I’ll open another for the |
|
Thanks for this, @9999years! Any chance we'll see you at one of our sprints this year? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With PEP 566, the
long_descriptioncan be Markdown with thelong_description_content_typearg. This adds documentation for itThere were also a couple cases where filenames were enclosed with quotes rather than as code; I've changed those to be
codeas well for consistency.See also:
packaging documentation
Note that this references the
README.mdadded in pypa/sampleproject#66, which is not yet merged. Merging that will break the link here, and merging this will result in a broken link until that PR is merged. Not sure what the best route there is.