summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-10-31 09:25:48 (GMT)
committerGeorg Brandl <georg@python.org>2014-10-31 09:25:48 (GMT)
commit500380135b25e79de3200afca449cf7b0da1198e (patch)
treedecb97fac1ad9504a7718ffb94b975d2c9a085b8 /Doc
parentfb52e38aba798042d1fae3959e318d149ee4d5d7 (diff)
downloadcpython-500380135b25e79de3200afca449cf7b0da1198e.zip
cpython-500380135b25e79de3200afca449cf7b0da1198e.tar.gz
cpython-500380135b25e79de3200afca449cf7b0da1198e.tar.bz2
#22613: minor other fixes in library docs (thanks Jacques Ducasse)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/ctypes.rst7
-rw-r--r--Doc/library/pydoc.rst7
-rw-r--r--Doc/library/tempfile.rst2
3 files changed, 9 insertions, 7 deletions
diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
index 4109d56..adb9595 100644
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -1909,7 +1909,7 @@ Utility functions
.. function:: find_msvcrt()
:module: ctypes.util
- Windows only: return the filename of the VC runtype library used by Python,
+ Windows only: return the filename of the VC runtime library used by Python,
and by the extension modules. If the name of the library cannot be
determined, ``None`` is returned.
@@ -2446,11 +2446,6 @@ other data types containing pointer type fields.
and so on). Later assignments to the :attr:`_fields_` class variable will
raise an AttributeError.
- Structure and union subclass constructors accept both positional and named
- arguments. Positional arguments are used to initialize the fields in the
- same order as they appear in the :attr:`_fields_` definition, named
- arguments are used to initialize the fields with the corresponding name.
-
It is possible to defined sub-subclasses of structure types, they inherit
the fields of the base class plus the :attr:`_fields_` defined in the
sub-subclass, if any.
diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst
index df37b71..494a48d 100644
--- a/Doc/library/pydoc.rst
+++ b/Doc/library/pydoc.rst
@@ -22,6 +22,13 @@ The :mod:`pydoc` module automatically generates documentation from Python
modules. The documentation can be presented as pages of text on the console,
served to a Web browser, or saved to HTML files.
+For modules, classes, functions and methods, the displayed documentation is
+derived from the docstring (i.e. the :attr:`__doc__` attribute) of the object,
+and recursively of its documentable members. If there is no docstring,
+:mod:`pydoc` tries to obtain a description from the block of comment lines just
+above the definition of the class, function or method in the source file, or at
+the top of the module (see :func:`inspect.getcomments`).
+
The built-in function :func:`help` invokes the online help system in the
interactive interpreter, which uses :mod:`pydoc` to generate its documentation
as text on the console. The same text documentation can also be viewed from
diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst
index 827f5f5..67eda21 100644
--- a/Doc/library/tempfile.rst
+++ b/Doc/library/tempfile.rst
@@ -185,7 +185,7 @@ The module defines the following user-callable functions:
>>> os.path.exists(f.name)
False
-The module uses two global variables that tell it how to construct a
+The module uses a global variable that tell it how to construct a
temporary name. They are initialized at the first call to any of the
functions above. The caller may change them, but this is discouraged; use
the appropriate function arguments, instead.