diff options
| -rw-r--r-- | Doc/distutils/examples.rst | 10 | ||||
| -rw-r--r-- | Doc/distutils/uploading.rst | 11 | ||||
| -rw-r--r-- | Doc/library/email.message.rst | 9 | ||||
| -rw-r--r-- | Doc/whatsnew/3.2.rst | 4 |
4 files changed, 18 insertions, 16 deletions
diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst index 648063b..e31ff72 100644 --- a/Doc/distutils/examples.rst +++ b/Doc/distutils/examples.rst @@ -257,10 +257,9 @@ Running the ``check`` command will display some warnings:: (maintainer and maintainer_email) must be supplied -If you use the reStructuredText syntax in the `long_description` field and -`docutils <http://docutils.sourceforge.net/>`_ is installed you can check if -the syntax is fine with the ``check`` command, using the `restructuredtext` -option. +If you use the reStructuredText syntax in the ``long_description`` field and +`docutils`_ is installed you can check if the syntax is fine with the +``check`` command, using the ``restructuredtext`` option. For example, if the :file:`setup.py` script is changed like this:: @@ -278,7 +277,7 @@ For example, if the :file:`setup.py` script is changed like this:: url='http://example.com', long_description=desc) Where the long description is broken, ``check`` will be able to detect it -by using the `docutils` parser:: +by using the :mod:`docutils` parser:: $ pythontrunk setup.py check --restructuredtext running check @@ -291,3 +290,4 @@ by using the `docutils` parser:: .. % \section{Putting it all together} +.. _docutils: http://docutils.sourceforge.net diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst index e947245..68c1e52 100644 --- a/Doc/distutils/uploading.rst +++ b/Doc/distutils/uploading.rst @@ -60,13 +60,14 @@ in the package:: setup(name='Distutils', long_description=open('README.txt')) -In that case, `README.txt` is a regular reStructuredText text file located -in the root of the package besides `setup.py`. +In that case, :file:`README.txt` is a regular reStructuredText text file located +in the root of the package besides :file:`setup.py`. To prevent registering broken reStructuredText content, you can use the -:program:`rst2html` program that is provided by the `docutils` package -and check the ``long_description`` from the command line:: +:program:`rst2html` program that is provided by the :mod:`docutils` package and +check the ``long_description`` from the command line:: $ python setup.py --long-description | rst2html.py > output.html -`docutils` will display a warning if there's something wrong with your syntax. +:mod:`docutils` will display a warning if there's something wrong with your +syntax. diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst index dc305a7..47c1fcd 100644 --- a/Doc/library/email.message.rst +++ b/Doc/library/email.message.rst @@ -118,10 +118,11 @@ Here are the methods of the :class:`Message` class: When *decode* is ``False`` (the default) the body is returned as a string without decoding the :mailheader:`Content-Transfer-Encoding`. However, for a :mailheader:`Content-Transfer-Encoding` of 8bit, an attempt is made - to decode the original bytes using the `charset` specified by the - :mailheader:`Content-Type` header, using the `replace` error handler. If - no `charset` is specified, or if the `charset` given is not recognized by - the email package, the body is decoded using the default ASCII charset. + to decode the original bytes using the ``charset`` specified by the + :mailheader:`Content-Type` header, using the ``replace`` error handler. + If no ``charset`` is specified, or if the ``charset`` given is not + recognized by the email package, the body is decoded using the default + ASCII charset. .. method:: set_payload(payload, charset=None) diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst index 9ac966d..0d9b968 100644 --- a/Doc/whatsnew/3.2.rst +++ b/Doc/whatsnew/3.2.rst @@ -197,8 +197,8 @@ in bytes format. * Given bytes input to the model, :meth:`~email.message.Message.get_payload` will by default decode a message body that has a - :mailheader:`Content-Transfer-Encoding` of `8bit` using the charset specified - in the MIME headers and return the resulting string. + :mailheader:`Content-Transfer-Encoding` of ``8bit`` using the charset + specified in the MIME headers and return the resulting string. * Given bytes input to the model, :class:`~email.generator.Generator` will convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of |