summaryrefslogtreecommitdiffstats
path: root/Doc/documenting
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>2007-08-17 00:24:54 (GMT)
committerGuido van Rossum <guido@python.org>2007-08-17 00:24:54 (GMT)
commitda27fd267346e213512f4835dd0b7b40e6172bbe (patch)
tree8f9f7dbafb09976c7dbe412992e9270f62455246 /Doc/documenting
parentaf554a0e17ceb0e6a3cc0c07e9cf6db2f80c1ad9 (diff)
downloadcpython-da27fd267346e213512f4835dd0b7b40e6172bbe.zip
cpython-da27fd267346e213512f4835dd0b7b40e6172bbe.tar.gz
cpython-da27fd267346e213512f4835dd0b7b40e6172bbe.tar.bz2
Manually patched a few things that didn't get merged in, but should.
Diffstat (limited to 'Doc/documenting')
-rw-r--r--Doc/documenting/markup.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 831fad9..ce042a5 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -79,6 +79,9 @@ As you can see, the module-specific markup consists of two directives, the
The ``synopsis`` option should consist of one sentence describing the
module's purpose -- it is currently only used in the Global Module Index.
+ The ``deprecated`` option can be given (with no value) to mark a module as
+ deprecated; it will be designated as such in various locations then.
+
.. describe:: moduleauthor
The ``moduleauthor`` directive, which can appear multiple times, names the
@@ -333,6 +336,13 @@ the current module, or the built-in function of that name. In contrast,
``:func:`foo.filter``` clearly refers to the ``filter`` function in the ``foo``
module.
+Normally, names in these roles are searched first without any further
+qualification, then with the current module name prepended, then with the
+current module and class name (if any) prepended. If you prefix the name with a
+dot, this order is reversed. For example, in the documentation of the
+:mod:`codecs` module, ``:func:`open``` always refers to the built-in function,
+while ``:func:`.open``` refers to :func:`codecs.open`.
+
A similar heuristic is used to determine whether the name is an attribute of
the currently documented class.