summaryrefslogtreecommitdiff
path: root/Doc/library/pyclbr.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library/pyclbr.rst')
-rw-r--r--Doc/library/pyclbr.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/library/pyclbr.rst b/Doc/library/pyclbr.rst
index b80a2faed9..36e83e85c2 100644
--- a/Doc/library/pyclbr.rst
+++ b/Doc/library/pyclbr.rst
@@ -1,8 +1,8 @@
-:mod:`pyclbr` --- Python class browser support
-==============================================
+:mod:`pyclbr` --- Python module browser support
+===============================================
.. module:: pyclbr
- :synopsis: Supports information extraction for a Python class browser.
+ :synopsis: Supports information extraction for a Python module browser.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
@@ -29,6 +29,9 @@ modules.
*path* is a sequence of directory paths prepended to ``sys.path``,
which is used to locate the module source code.
+ This function is the original interface and is only kept for back
+ compatibility. It returns a filtered version of the following.
+
.. function:: readmodule_ex(module, path=None)