summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-04-24 00:34:11 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-04-24 00:34:11 (GMT)
commit5348b63a91e3517116fcef2a9e7019b640aa6c9f (patch)
treedd171bd8e060d227759ed3e1852dd646bc8cfd7b /Doc
parent7365accc20a5dff590fe3d7af7ec01b7173a59ea (diff)
parent2b9388a03325fa4452a8cb3b9df8a7fbb7302b87 (diff)
downloadcpython-5348b63a91e3517116fcef2a9e7019b640aa6c9f.zip
cpython-5348b63a91e3517116fcef2a9e7019b640aa6c9f.tar.gz
cpython-5348b63a91e3517116fcef2a9e7019b640aa6c9f.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/dbm.rst4
-rw-r--r--Doc/library/json.rst2
5 files changed, 26 insertions, 10 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/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::