[Python-checkins] r78862 - in python/branches/py3k/Doc: c-api/exceptions.rst c-api/unicode.rst distutils/examples.rst distutils/uploading.rst library/http.client.rst library/logging.rst library/site.rst library/sys.rst whatsnew/2.2.rst whatsnew/2.7.rst

georg.brandl python-checkins at python.org
Fri Mar 12 11:06:40 CET 2010 

Author: georg.brandl
Date: Fri Mar 12 11:06:40 2010
New Revision: 78862

Log:
Merged revisions 78859-78860 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78859 | georg.brandl | 2010-03-12 10:57:43 +0100 (Fr, 12 Mär 2010) | 1 line
  
  Get rid of backticks.
........
  r78860 | georg.brandl | 2010-03-12 11:02:03 +0100 (Fr, 12 Mär 2010) | 1 line
  
  Fix warnings from "make check".
........


Modified:
   python/branches/py3k/Doc/c-api/exceptions.rst
   python/branches/py3k/Doc/c-api/unicode.rst
   python/branches/py3k/Doc/distutils/examples.rst
   python/branches/py3k/Doc/distutils/uploading.rst
   python/branches/py3k/Doc/library/http.client.rst
   python/branches/py3k/Doc/library/logging.rst
   python/branches/py3k/Doc/library/site.rst
   python/branches/py3k/Doc/library/sys.rst
   python/branches/py3k/Doc/whatsnew/2.2.rst
   python/branches/py3k/Doc/whatsnew/2.7.rst

Modified: python/branches/py3k/Doc/c-api/exceptions.rst
==============================================================================
--- python/branches/py3k/Doc/c-api/exceptions.rst	(original)
+++ python/branches/py3k/Doc/c-api/exceptions.rst	Fri Mar 12 11:06:40 2010
@@ -214,7 +214,7 @@
    .. note::
 
       The `"%lld"` and `"%llu"` format specifiers are only available
-      when `HAVE_LONG_LONG` is defined.
+      when :const:`HAVE_LONG_LONG` is defined.
 
    .. versionchanged:: 3.2
       Support for `"%lld"` and `"%llu"` added.

Modified: python/branches/py3k/Doc/c-api/unicode.rst
==============================================================================
--- python/branches/py3k/Doc/c-api/unicode.rst	(original)
+++ python/branches/py3k/Doc/c-api/unicode.rst	Fri Mar 12 11:06:40 2010
@@ -313,7 +313,7 @@
    .. note::
 
       The `"%lld"` and `"%llu"` format specifiers are only available
-      when `HAVE_LONG_LONG` is defined.
+      when :const:`HAVE_LONG_LONG` is defined.
 
    .. versionchanged:: 3.2
       Support for `"%lld"` and `"%llu"` added.

Modified: python/branches/py3k/Doc/distutils/examples.rst
==============================================================================
--- python/branches/py3k/Doc/distutils/examples.rst	(original)
+++ python/branches/py3k/Doc/distutils/examples.rst	Fri Mar 12 11:06:40 2010
@@ -257,9 +257,9 @@
              (maintainer and maintainer_email) must be supplied
 
 
-If you use the reStructuredText syntax in the `long_description` field and
+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`
+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 +278,7 @@
         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
@@ -293,20 +293,20 @@
 
 The :func:`distutils.core.setup` function provides a command-line interface
 that allows you to query the metadata fields of a project through the
-`setup.py` script of a given project::
+:file:`setup.py` script of a given project::
 
     $ python setup.py --name
     distribute
 
-This call reads the `name` metadata by running the
+This call reads the ``name`` metadata by running the
 :func:`distutils.core.setup`  function. Although, when a source or binary
 distribution is created with Distutils, the metadata fields are written
 in a static file called :file:`PKG-INFO`. When a Distutils-based project is
 installed in Python, the :file:`PKG-INFO` file is copied alongside the modules
 and packages of the distribution under :file:`NAME-VERSION-pyX.X.egg-info`,
-where `NAME` is the name of the project, `VERSION` its version as defined
-in the Metadata, and `pyX.X` the major and minor version of Python like
-`2.7` or `3.2`.
+where ``NAME`` is the name of the project, ``VERSION`` its version as defined
+in the Metadata, and ``pyX.X`` the major and minor version of Python like
+``2.7`` or ``3.2``.
 
 You can read back this static file, by using the
 :class:`distutils.dist.DistributionMetadata` class and its

Modified: python/branches/py3k/Doc/distutils/uploading.rst
==============================================================================
--- python/branches/py3k/Doc/distutils/uploading.rst	(original)
+++ python/branches/py3k/Doc/distutils/uploading.rst	Fri Mar 12 11:06:40 2010
@@ -60,13 +60,13 @@
     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
+: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.

Modified: python/branches/py3k/Doc/library/http.client.rst
==============================================================================
--- python/branches/py3k/Doc/library/http.client.rst	(original)
+++ python/branches/py3k/Doc/library/http.client.rst	Fri Mar 12 11:06:40 2010
@@ -498,7 +498,7 @@
 
 .. attribute:: HTTPResponse.debuglevel
 
-   A debugging hook.  If `debuglevel` is greater than zero, messages
+   A debugging hook.  If :attr:`debuglevel` is greater than zero, messages
    will be printed to stdout as the response is read and parsed.
 
 

Modified: python/branches/py3k/Doc/library/logging.rst
==============================================================================
--- python/branches/py3k/Doc/library/logging.rst	(original)
+++ python/branches/py3k/Doc/library/logging.rst	Fri Mar 12 11:06:40 2010
@@ -1210,12 +1210,12 @@
 :class:`Handler` subclass are passed to its :meth:`handleError` method.
 
 The default implementation of :meth:`handleError` in :class:`Handler` checks
-to see if a module-level variable, `raiseExceptions`, is set. If set, a
-traceback is printed to `sys.stderr`. If not set, the exception is swallowed.
+to see if a module-level variable, :data:`raiseExceptions`, is set. If set, a
+traceback is printed to :data:`sys.stderr`. If not set, the exception is swallowed.
 
-**Note:** The default value of `raiseExceptions` is `True`. This is because
+**Note:** The default value of :data:`raiseExceptions` is ``True``. This is because
 during development, you typically want to be notified of any exceptions that
-occur. It's advised that you set `raiseExceptions` to `False` for production
+occur. It's advised that you set :data:`raiseExceptions` to ``False`` for production
 usage.
 
 .. _context-info:

Modified: python/branches/py3k/Doc/library/site.rst
==============================================================================
--- python/branches/py3k/Doc/library/site.rst	(original)
+++ python/branches/py3k/Doc/library/site.rst	Fri Mar 12 11:06:40 2010
@@ -124,9 +124,9 @@
 
 .. function:: getuserbase()
 
-   Returns the `user base` directory path.
+   Returns the "user base" directory path.
 
-   The `user base` directory can be used to store data. If the global
+   The "user base" directory can be used to store data. If the global
    variable ``USER_BASE`` is not initialized yet, this function will also set
    it.
 

Modified: python/branches/py3k/Doc/library/sys.rst
==============================================================================
--- python/branches/py3k/Doc/library/sys.rst	(original)
+++ python/branches/py3k/Doc/library/sys.rst	Fri Mar 12 11:06:40 2010
@@ -339,7 +339,7 @@
    specific.
 
    If given, *default* will be returned if the object does not provide means to
-   retrieve the size.  Otherwise a `TypeError` will be raised.
+   retrieve the size.  Otherwise a :exc:`TypeError` will be raised.
 
    :func:`getsizeof` calls the object's ``__sizeof__`` method and adds an
    additional garbage collector overhead if the object is managed by the garbage

Modified: python/branches/py3k/Doc/whatsnew/2.2.rst
==============================================================================
--- python/branches/py3k/Doc/whatsnew/2.2.rst	(original)
+++ python/branches/py3k/Doc/whatsnew/2.2.rst	Fri Mar 12 11:06:40 2010
@@ -30,7 +30,7 @@
 to the PEP for a particular new feature.
 
 
-.. seealso (now defunct)
+.. see also, now defunct
 
    http://www.unixreview.com/documents/s=1356/urm0109h/0109h.htm
       "What's So Special About Python 2.2?" is also about the new 2.2 features, and

Modified: python/branches/py3k/Doc/whatsnew/2.7.rst
==============================================================================
--- python/branches/py3k/Doc/whatsnew/2.7.rst	(original)
+++ python/branches/py3k/Doc/whatsnew/2.7.rst	Fri Mar 12 11:06:40 2010
@@ -539,7 +539,7 @@
 
   Contributed by Raymond Hettinger; :issue:`1696199`.
 
-  The new `OrderedDict` class is described in the earlier section
+  The new `~collections.OrderedDict` class is described in the earlier section
   :ref:`pep-0372`.
 
   The :class:`namedtuple` class now has an optional *rename* parameter.

More information about the Python-checkins mailing list