traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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>
This commit is contained in:
Hakan Çelik 2020-02-24 05:00:40 +03:00 committed by GitHub
parent 9f37872e30
commit aea045adb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/library/pyclbr.rst
View File

@ -1,8 +1,8 @@
:mod:`pyclbr` --- Python class browser support :mod:`pyclbr` --- Python module browser support
============================================== ===============================================
.. module:: pyclbr .. 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> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
@ -29,6 +29,9 @@ modules.
*path* is a sequence of directory paths prepended to ``sys.path``, *path* is a sequence of directory paths prepended to ``sys.path``,
which is used to locate the module source code. 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) .. function:: readmodule_ex(module, path=None)

2
Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst Normal file
View File

@ -0,0 +1,2 @@
In pyclbr doc, update 'class' to 'module' where appropriate and add readmodule comment.
Patch by Hakan Çelik.