[Python-checkins] (no subject)

Hakan Çelik webhook-mailer at python.org
Sun Feb 23 21:00:45 EST 2020




To: python-checkins at python.org
Subject: bpo-39654: Update pyclbr doc to reflect additional information
 returned (GH-18528)
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0

https://github.com/python/cpython/commit/aea045adb8c90394264908670cbc495c5a41=
b65e
commit: aea045adb8c90394264908670cbc495c5a41b65e
branch: master
author: Hakan =C3=87elik <hakancelik96 at outlook.com>
committer: GitHub <noreply at github.com>
date: 2020-02-23T21:00:40-05:00
summary:

bpo-39654: Update pyclbr doc to reflect additional information returned (GH-1=
8528)

Full nested function and class info makes it a module browser.

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.co=
m>
Co-authored-by: Terry Jan Reedy <tjreedy at udel.edu>

files:
A Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst
M Doc/library/pyclbr.rst

diff --git a/Doc/library/pyclbr.rst b/Doc/library/pyclbr.rst
index b80a2faed9b42..36e83e85c2314 100644
--- a/Doc/library/pyclbr.rst
+++ b/Doc/library/pyclbr.rst
@@ -1,8 +1,8 @@
-:mod:`pyclbr` --- Python class browser support
-=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+:mod:`pyclbr` --- Python module browser support
+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
=20
 .. module:: pyclbr
-   :synopsis: Supports information extraction for a Python class browser.
+   :synopsis: Supports information extraction for a Python module browser.
=20
 .. sectionauthor:: Fred L. Drake, Jr. <fdrake at acm.org>
=20
@@ -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.
=20
+   This function is the original interface and is only kept for back
+   compatibility.  It returns a filtered version of the following.
+
=20
 .. function:: readmodule_ex(module, path=3DNone)
=20
diff --git a/Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT=
1jI.rst b/Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI=
.rst
new file mode 100644
index 0000000000000..cff201d812476
--- /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 readmodu=
le comment.
+Patch by Hakan =C3=87elik.



More information about the Python-checkins mailing list