From 8a425bfc09d24be291480108e66a99771a82f192 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hakan=20=C3=87EL=C4=B0K?= Date: Sun, 16 Feb 2020 21:52:36 +0300 Subject: [PATCH 1/4] bpo-39654: pyclbr: remove old references to class browser & add explain readmodule --- Doc/library/pyclbr.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Doc/library/pyclbr.rst b/Doc/library/pyclbr.rst index b80a2faed9b424..df74d06b57b4a5 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. @@ -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 a filtered version kept for the backwards compatibility which + is the original interface, before Functions were added. + .. function:: readmodule_ex(module, path=None) From 56eb8692eead5a923344111fb47b434e18359f82 Mon Sep 17 00:00:00 2001 From: "blurb-it[bot]" <43283697+blurb-it[bot]@users.noreply.github.com> Date: Tue, 18 Feb 2020 07:42:21 +0000 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=93=9C=F0=9F=A4=96=20Added=20by=20blu?= =?UTF-8?q?rb=5Fit.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst 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 00000000000000..010d2b953761ff --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst @@ -0,0 +1 @@ +Remove old references to class browser and add explain to readmodule in pyclbr by Hakan Çelik. \ No newline at end of file From ffc379ce2170bf82bdfed17fb2b9132658085d92 Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Sun, 23 Feb 2020 20:35:19 -0500 Subject: [PATCH 3/4] Update pyclbr.rst --- Doc/library/pyclbr.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/pyclbr.rst b/Doc/library/pyclbr.rst index df74d06b57b4a5..36e83e85c23141 100644 --- a/Doc/library/pyclbr.rst +++ b/Doc/library/pyclbr.rst @@ -29,8 +29,8 @@ modules. *path* is a sequence of directory paths prepended to ``sys.path``, which is used to locate the module source code. - This function is a filtered version kept for the backwards compatibility which - is the original interface, before Functions were added. + 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) From b2aa8afddb6f6bc74066123566d301e9979350ac Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Sun, 23 Feb 2020 20:40:48 -0500 Subject: [PATCH 4/4] Update 2020-02-18-07-42-20.bpo-39654.MoT1jI.rst --- .../Documentation/2020-02-18-07-42-20.bpo-39654.MoT1jI.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 index 010d2b953761ff..cff201d8124769 100644 --- 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 @@ -1 +1,2 @@ -Remove old references to class browser and add explain to readmodule in pyclbr by Hakan Çelik. \ No newline at end of file +In pyclbr doc, update 'class' to 'module' where appropriate and add readmodule comment. +Patch by Hakan Çelik.