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 194a085
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 @@ -53,6 +53,11 @@
# Often, this is the same as your README, so you can just read it in from
# that file directly (as we have already done above)
#
# 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" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-optional
long_description=long_description, # Optional
Expand Down

0 comments on commit 194a085

Please sign in to comment.