From: Eli Bendersky <eliben@gmail.com>
Date: Wed, 1 Aug 2012 23:56:39 +0000 (+0300)
Subject: Issue #15321: update PyPI upload doc to say --no-raw passed to rst2html.py
X-Git-Tag: v3.3.0b2~62^2~1
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f37c0c73fef929a3bf3239bc10fd8ca0d63bcd9c;p=python

Issue #15321: update PyPI upload doc to say --no-raw passed to rst2html.py
---

diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst
index 1b3cb589ec..bfb392e3b6 100644
--- a/Doc/distutils/uploading.rst
+++ b/Doc/distutils/uploading.rst
@@ -73,4 +73,8 @@ check the ``long_description`` from the command line::
     $ python setup.py --long-description | rst2html.py > output.html
 
 :mod:`docutils` will display a warning if there's something wrong with your
-syntax.
+syntax.  Because PyPI applies additional checks (e.g. by passing ``--no-raw``
+to ``rst2html.py`` in the command above), being able to run the command above
+without warnings does not guarantee that PyPI will convert the content
+successfully.
+