summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-03-12 10:02:03 (GMT)
committerGeorg Brandl <georg@python.org>2010-03-12 10:02:03 (GMT)
commitf6d3674599cb1f03da78aaf8800def5086bb9879 (patch)
treedd416334149738acef8848dfa3ce59d866bd4bb7 /Doc
parent554272743a597cfde468fbc0dd200859a6648b56 (diff)
downloadcpython-f6d3674599cb1f03da78aaf8800def5086bb9879.zip
cpython-f6d3674599cb1f03da78aaf8800def5086bb9879.tar.gz
cpython-f6d3674599cb1f03da78aaf8800def5086bb9879.tar.bz2
Fix warnings from "make check".
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/exceptions.rst2
-rw-r--r--Doc/c-api/string.rst2
-rw-r--r--Doc/distutils/examples.rst16
-rw-r--r--Doc/distutils/uploading.rst8
-rw-r--r--Doc/library/logging.rst24
-rw-r--r--Doc/library/site.rst4
-rw-r--r--Doc/library/sys.rst2
-rw-r--r--Doc/whatsnew/2.2.rst2
-rw-r--r--Doc/whatsnew/2.7.rst2
9 files changed, 31 insertions, 31 deletions
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index d4a13ae..79e05f1 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -221,7 +221,7 @@ is a separate error indicator for each thread.
.. note::
The `"%lld"` and `"%llu"` format specifiers are only available
- when `HAVE_LONG_LONG` is defined.
+ when :const:`HAVE_LONG_LONG` is defined.
.. versionchanged:: 2.7
Support for `"%lld"` and `"%llu"` added.
diff --git a/Doc/c-api/string.rst b/Doc/c-api/string.rst
index 99fec5d..9b95859 100644
--- a/Doc/c-api/string.rst
+++ b/Doc/c-api/string.rst
@@ -138,7 +138,7 @@ called with a non-string parameter.
.. note::
The `"%lld"` and `"%llu"` format specifiers are only available
- when `HAVE_LONG_LONG` is defined.
+ when :const:`HAVE_LONG_LONG` is defined.
.. versionchanged:: 2.7
Support for `"%lld"` and `"%llu"` added.
diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst
index 60656e7..a5a0239 100644
--- a/Doc/distutils/examples.rst
+++ b/Doc/distutils/examples.rst
@@ -257,9 +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
+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 @@ 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
@@ -293,20 +293,20 @@ Reading the metadata
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
diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst
index 84388c2..1da8536 100644
--- a/Doc/distutils/uploading.rst
+++ b/Doc/distutils/uploading.rst
@@ -62,13 +62,13 @@ 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
+: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/logging.rst b/Doc/library/logging.rst
index 3d2eeef..8bdea10 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -424,10 +424,10 @@ noncoders to easily modify the logging properties.
Note that the class names referenced in config files need to be either relative
to the logging module, or absolute values which can be resolved using normal
-import mechanisms. Thus, you could use either `handlers.WatchedFileHandler`
-(relative to the logging module) or `mypackage.mymodule.MyHandler` (for a
-class defined in package `mypackage` and module `mymodule`, where `mypackage`
-is available on the Python import path).
+import mechanisms. Thus, you could use either :class:`handlers.WatchedFileHandler`
+(relative to the logging module) or :class:`mypackage.mymodule.MyHandler` (for a
+class defined in package :mod:`mypackage` and module :mod:`mymodule`, where
+:mod:`mypackage` is available on the Python import path).
.. _library-config:
@@ -1233,12 +1233,12 @@ swallowed. Other exceptions which occur during the :meth:`emit` method of a
: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:
@@ -2494,14 +2494,14 @@ with the :mod:`warnings` module.
This function is used to turn the capture of warnings by logging on and
off.
- If `capture` is `True`, warnings issued by the :mod:`warnings` module
+ If *capture* is ``True``, warnings issued by the :mod:`warnings` module
will be redirected to the logging system. Specifically, a warning will be
formatted using :func:`warnings.formatwarning` and the resulting string
- logged to a logger named "py.warnings" with a severity of `WARNING`.
+ logged to a logger named "py.warnings" with a severity of ``WARNING``.
- If `capture` is `False`, the redirection of warnings to the logging system
+ If *capture* is ``False``, the redirection of warnings to the logging system
will stop, and warnings will be redirected to their original destinations
- (i.e. those in effect before `captureWarnings(True)` was called).
+ (i.e. those in effect before ``captureWarnings(True)`` was called).
Configuration
diff --git a/Doc/library/site.rst b/Doc/library/site.rst
index 9616105..6ad156e 100644
--- a/Doc/library/site.rst
+++ b/Doc/library/site.rst
@@ -140,9 +140,9 @@ empty, and the path manipulations are skipped; however the import of
.. 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.
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index b535c22..807245f 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -417,7 +417,7 @@ always available.
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
diff --git a/Doc/whatsnew/2.2.rst b/Doc/whatsnew/2.2.rst
index 31e8dd0..89e4d76 100644
--- a/Doc/whatsnew/2.2.rst
+++ b/Doc/whatsnew/2.2.rst
@@ -30,7 +30,7 @@ understand the complete implementation and design rationale for a change, refer
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
diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst
index 540b429..d9ade51 100644
--- a/Doc/whatsnew/2.7.rst
+++ b/Doc/whatsnew/2.7.rst
@@ -609,7 +609,7 @@ changes, or look through the Subversion logs for all the details.
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.