diff options
| author | Hakan Çelik <hakancelik96@outlook.com> | 2020-02-24 05:00:40 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-23 21:00:40 -0500 |
| commit | aea045adb8c90394264908670cbc495c5a41b65e (patch) | |
| tree | 9bb463b5043e624cc77cf81ea18bf73f86a44c31 | |
| parent | 9f37872e307734666a7169f7be6e3370d3068282 (diff) | |
| download | cpython-git-aea045adb8c90394264908670cbc495c5a41b65e.tar.gz | |
bpo-39654: Update pyclbr doc to reflect additional information returned (GH-18528)
Full nested function and class info makes it a module browser.
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
| -rw-r--r-- | Doc/library/pyclbr.rst | 9 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst | 2 |
2 files changed, 8 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) diff --git a/Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst b/Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst new file mode 100644 index 0000000000..cff201d812 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst @@ -0,0 +1,2 @@ +In pyclbr doc, update 'class' to 'module' where appropriate and add readmodule comment. +Patch by Hakan Çelik. |