diff options
author | Éric Araujo <merwok@netwok.org> | 2011-04-24 00:39:43 (GMT) |
---|---|---|
committer | Éric Araujo <merwok@netwok.org> | 2011-04-24 00:39:43 (GMT) |
commit | cae1be85f5ac78a7ec73d129ca46cdfc5c5a5ad9 (patch) | |
tree | 786ea49a8c479b6cc89f6801925bcadd3786c9b5 /Doc | |
parent | 5569e9b1507ac0ff18fec433a7733a0185dde7b0 (diff) | |
parent | 37e6c54ba122703a0162dd44cf3eac78c46c8bdd (diff) | |
download | cpython-cae1be85f5ac78a7ec73d129ca46cdfc5c5a5ad9.zip cpython-cae1be85f5ac78a7ec73d129ca46cdfc5c5a5ad9.tar.gz cpython-cae1be85f5ac78a7ec73d129ca46cdfc5c5a5ad9.tar.bz2 |
Branch merge
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/c-api/intro.rst | 3 | ||||
-rw-r--r-- | Doc/documenting/markup.rst | 25 | ||||
-rw-r--r-- | Doc/library/dbm.rst | 4 |
3 files changed, 24 insertions, 8 deletions
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst index 0c4f816..83b98f9 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 :c:func:`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_SetArgvEx() diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 277ca9f..1f5b1e3 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 @@ -217,13 +217,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:: decoratormethod diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index 0cd873e..e3d50b9 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, |