summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-04-27 14:23:56 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-04-27 14:23:56 (GMT)
commit9a42793761ddedc59f03a5fe0f0150e11676713f (patch)
tree0a0058c6138c7d6a47ae242adf48c31b7f7c22c6 /Doc
parent935a5888255b60b77547e7bdf32e03fbe963ef52 (diff)
parent10f3d7acbd69206bd9166f812d0503fed187eb5b (diff)
downloadcpython-9a42793761ddedc59f03a5fe0f0150e11676713f.zip
cpython-9a42793761ddedc59f03a5fe0f0150e11676713f.tar.gz
cpython-9a42793761ddedc59f03a5fe0f0150e11676713f.tar.bz2
Branch merge
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/intro.rst3
-rw-r--r--Doc/distutils/examples.rst2
-rw-r--r--Doc/documenting/markup.rst25
-rw-r--r--Doc/library/__future__.rst2
-rw-r--r--Doc/library/dbm.rst4
-rw-r--r--Doc/library/json.rst2
-rw-r--r--Doc/library/sys.rst4
-rw-r--r--Doc/library/wsgiref.rst2
8 files changed, 30 insertions, 14 deletions
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index e8b62dc..c008b5c 100644
--- a/Doc/c-api/intro.rst
+++ b/Doc/c-api/intro.rst
@@ -511,13 +511,12 @@ interpreter can only be used after the interpreter has been initialized.
module: builtins
module: __main__
module: sys
- module: exceptions
triple: module; search; path
single: path (in module sys)
The basic initialization function is :cfunc:`Py_Initialize`. This initializes
the table of loaded modules, and creates the fundamental modules
-:mod:`builtins`, :mod:`__main__`, :mod:`sys`, and :mod:`exceptions`. It also
+:mod:`builtins`, :mod:`__main__`, and :mod:`sys`. It also
initializes the module search path (``sys.path``).
.. index:: single: PySys_SetArgv()
diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst
index 6c27738..e8d1ec9 100644
--- a/Doc/distutils/examples.rst
+++ b/Doc/distutils/examples.rst
@@ -280,7 +280,7 @@ For example, if the :file:`setup.py` script is changed like this::
Where the long description is broken, ``check`` will be able to detect it
by using the :mod:`docutils` parser::
- $ pythontrunk setup.py check --restructuredtext
+ $ python setup.py check --restructuredtext
running check
warning: check: Title underline too short. (line 2)
warning: check: Could not finish the parsing.
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 34a79d4..be7718d 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -152,7 +152,7 @@ The directives are:
Describes global data in a module, including both variables and values used
as "defined constants." Class and object attributes are not documented
- using this environment.
+ using this directive.
.. describe:: exception
@@ -165,7 +165,7 @@ The directives are:
parameters, enclosing optional parameters in brackets. Default values can be
given if it enhances clarity. For example::
- .. function:: Timer.repeat([repeat=3[, number=1000000]])
+ .. function:: repeat([repeat=3[, number=1000000]])
Object methods are not documented using this directive. Bound object methods
placed in the module namespace as part of the public interface of the module
@@ -186,13 +186,30 @@ The directives are:
Describes an object data attribute. The description should include
information about the type of the data to be expected and whether it may be
- changed directly.
+ changed directly. This directive should be nested in a class directive,
+ like in this example::
+
+ .. class:: Spam
+
+ Description of the class.
+
+ .. data:: ham
+
+ Description of the attribute.
+
+ If is also possible to document an attribute outside of a class directive,
+ for example if the documentation for different attributes and methods is
+ split in multiple sections. The class name should then be included
+ explicitly::
+
+ .. data:: Spam.eggs
.. describe:: method
Describes an object method. The parameters should not include the ``self``
parameter. The description should include similar information to that
- described for ``function``.
+ described for ``function``. This method should be nested in a class
+ method, like in the example above.
.. describe:: opcode
diff --git a/Doc/library/__future__.rst b/Doc/library/__future__.rst
index 3c42393..2348217 100644
--- a/Doc/library/__future__.rst
+++ b/Doc/library/__future__.rst
@@ -26,7 +26,7 @@ Each statement in :file:`__future__.py` is of the form::
where, normally, *OptionalRelease* is less than *MandatoryRelease*, and both are
-5-tuples of the same form as ``sys.version_info``::
+5-tuples of the same form as :data:`sys.version_info`::
(PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int
PY_MINOR_VERSION, # the 1; an int
diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst
index c7c7347..cbefc1a 100644
--- a/Doc/library/dbm.rst
+++ b/Doc/library/dbm.rst
@@ -30,9 +30,9 @@ the Oracle Berkeley DB.
name, such as ``'dbm.ndbm'`` or ``'dbm.gnu'``.
-.. function:: open(filename, flag='r', mode=0o666)
+.. function:: open(file, flag='r', mode=0o666)
- Open the database file *filename* and return a corresponding object.
+ Open the database file *file* and return a corresponding object.
If the database file already exists, the :func:`whichdb` function is used to
determine its type and the appropriate module is used; if it does not exist,
diff --git a/Doc/library/json.rst b/Doc/library/json.rst
index 6bb48e8..48acaf1 100644
--- a/Doc/library/json.rst
+++ b/Doc/library/json.rst
@@ -34,7 +34,7 @@ Encoding basic Python object hierarchies::
Compact encoding::
>>> import json
- >>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',',':'))
+ >>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',', ':'))
'[1,2,3,{"4":5,"6":7}]'
Pretty printing::
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 148630c..c61fedb 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -447,8 +447,8 @@ always available.
This is called ``hexversion`` since it only really looks meaningful when viewed
as the result of passing it to the built-in :func:`hex` function. The
- ``version_info`` value may be used for a more human-friendly encoding of the
- same information.
+ struct sequence :data:`sys.version_info` may be used for a more human-friendly
+ encoding of the same information.
The ``hexversion`` is a 32-bit number with the following layout
diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst
index fda9e70..231449c 100644
--- a/Doc/library/wsgiref.rst
+++ b/Doc/library/wsgiref.rst
@@ -664,7 +664,7 @@ input, output, and error streams.
.. attribute:: BaseHandler.wsgi_file_wrapper
A ``wsgi.file_wrapper`` factory, or ``None``. The default value of this
- attribute is the :class:`FileWrapper` class from :mod:`wsgiref.util`.
+ attribute is the :class:`wsgiref.util.FileWrapper` class.
.. method:: BaseHandler.sendfile()