Skip to content

Commit

Permalink
Update docs about check to talk about Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
di committed Apr 3, 2018
1 parent 4edac47 commit 709766d
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ reStructuredText (``.rst``), and plain text.
Check Description Locally
-------------------------

To check your long descriptions locally simply install the
``readme_renderer`` library using:
reStructuredText
~~~~~~~~~~~~~~~~

To locally check whether your reStructuredText long descriptions will render on
PyPI, simply install the ``readme_renderer`` library using:

.. code-block:: console
Expand All @@ -25,6 +28,16 @@ If there's a problem rendering your ``long_description``, the check
will tell you. If your ``long_description`` is fine, you'll get no
output.


Markdown
~~~~~~~~

Checking your Markdown long descriptions is unecessary, because unlike rST,
where a properly rendered description is all-or-nothing, PyPI will still render
your Markdown description as Markdown if it has some invalid or incorrect
syntax.


Code of Conduct
---------------

Expand Down

0 comments on commit 709766d

Please sign in to comment.