[issue17375] Add docstrings to methods in the threading module
New submission from Raymond Hettinger: It should be an easy task fill-in the missing docstrings using the verbiage in the regular docs. ---------- assignee: docs@python components: Documentation keywords: easy messages: 183645 nosy: docs@python, rhettinger priority: normal severity: normal status: open title: Add docstrings to methods in the threading module versions: Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
karl added the comment: Here an attempt at fixing it. See issue-17375-1.patch for Python 3.3 Hope it helps. ---------- keywords: +patch nosy: +karlcow Added file: http://bugs.python.org/file29338/issue-17375-1.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
Eli Bendersky added the comment: Duplicate of #12768? karl - feel free to review the patch submitted to that issue and offer your insights. ---------- nosy: +eli.bendersky _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
karl added the comment: Ah bummer! :) it was already done. :) Well it seems already well commented in the review. :) Closing this one as duplicate? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
Roundup Robot added the comment: New changeset e0ef2bde35c3 by Raymond Hettinger in branch '2.7': Issue #17375: Add docstrings to the threading module. http://hg.python.org/cpython/rev/e0ef2bde35c3 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
Eli Bendersky added the comment: Raymond - which patch is it? You didn't specify the contributor in the commit. What about the duplicate issue #12768 where someone also worked to supply a patch? Also, you've only committed this to 2.7; why? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
Raymond Hettinger added the comment:
You didn't specify the contributor in the commit.
I'm the contributor.
Also, you've only committed this to 2.7; why? I committed to 2.7 because the 2.7 docs were the source. When I get the time, I will build a 3.x version of the update.
---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
Eli Bendersky added the comment: On Wed, Mar 13, 2013 at 2:52 AM, Raymond Hettinger <report@bugs.python.org>wrote:
Raymond Hettinger added the comment:
You didn't specify the contributor in the commit.
I'm the contributor.
Oh, I see. I thought it's taken from one of the two existing patches from new contributors, either in this issue or #12768.
Also, you've only committed this to 2.7; why? I committed to 2.7 because the 2.7 docs were the source. When I get the time, I will build a 3.x version of the update.
OK. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
moijes12 added the comment: Attached is a patch built against Python 3.3. I've taken karlcow's patch and used it for Python 3. I have run the test suite(./python -m test -j3) and the sanity check (make patchcheck) and they worked fine. ---------- nosy: +moijes12 Added file: http://bugs.python.org/file30425/issue-17375-python33.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
Changes by Eli Bendersky <eliben@gmail.com>: ---------- nosy: -eli.bendersky _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
Roundup Robot added the comment: New changeset 24429118988b by Georg Brandl in branch '3.3': Closes #17375: port new threading docstrings from 2.7. http://hg.python.org/cpython/rev/24429118988b ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17375> _______________________________________
participants (6)
-
Eli Bendersky -
Ezio Melotti
-
karl
-
moijes12
-
Raymond Hettinger
-
Roundup Robot