Skip to content

Commit

Permalink
Clarified when content_type is optional
Browse files Browse the repository at this point in the history
Added a comment clarifying that `long_description_content_type` in `setup()`
is only optional if the `long_description` is written in RST and a quote
from relevant documentation.
  • Loading branch information
Rebecca Turner committed Mar 20, 2018
1 parent 5be0970 commit 10bef87
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@
# Denotes that our long_description is in Markdown; valid values are
# text/plain, text/x-rst, and text/markdown
#
# Optional if long_description is written in rst but required for
# plain-text or Markdown; if unspecified, "applications should attempt to
# render [the long_description] as text/x-rst; charset=UTF-8 and fall back
# to text/plain if it is not valid rst" (see link below)
#
# This field corresponds to the "Description-Content-Type" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
long_description_content_type='text/markdown', # Optional
Expand Down

0 comments on commit 10bef87

Please sign in to comment.