This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Add docstrings to methods in the threading module
Type: Stage: resolved
Components: Documentation Versions: Python 3.3, Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, ezio.melotti, karlcow, moijes12, python-dev, rhettinger
Priority: normal Keywords: easy, patch

Created on 2013-03-07 09:24 by rhettinger, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue-17375-1.patch karlcow, 2013-03-07 13:33 review
issue-17375-python33.patch moijes12, 2013-05-30 09:36 review
Messages (10)
msg183645 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2013-03-07 09:24
It should be an easy task fill-in the missing docstrings using the verbiage in the regular docs.
msg183657 - (view) Author: karl (karlcow) * Date: 2013-03-07 13:33
Here an attempt at fixing it. See issue-17375-1.patch for Python 3.3

Hope it helps.
msg183658 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-03-07 13:42
Duplicate of #12768?

karl - feel free to review the patch submitted to that issue and offer your insights.
msg183660 - (view) Author: karl (karlcow) * Date: 2013-03-07 13:46
Ah bummer! :) it was already done. :) Well it seems already well commented in the review. :)

Closing this one as duplicate?
msg183791 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-03-09 04:02
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
msg183815 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-03-09 13:23
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?
msg184074 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2013-03-13 09:52
> 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.
msg184080 - (view) Author: Eli Bendersky (eli.bendersky) * (Python committer) Date: 2013-03-13 13:22
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.
msg190350 - (view) Author: moijes12 (moijes12) Date: 2013-05-30 09:36
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.
msg199673 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-10-13 08:43
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
History
Date User Action Args
2022-04-11 14:57:42adminsetgithub: 61577
2013-10-13 08:43:38python-devsetstatus: open -> closed
resolution: fixed
messages: + msg199673

stage: resolved
2013-06-08 15:56:47eli.benderskysetnosy: - eli.bendersky
2013-05-30 09:36:33moijes12setfiles: + issue-17375-python33.patch
nosy: + moijes12
messages: + msg190350

2013-03-13 13:22:42eli.benderskysetmessages: + msg184080
2013-03-13 09:52:34rhettingersetmessages: + msg184074
2013-03-12 04:11:18ezio.melottisetnosy: + ezio.melotti
2013-03-09 13:23:25eli.benderskysetmessages: + msg183815
2013-03-09 04:02:37python-devsetnosy: + python-dev
messages: + msg183791
2013-03-07 13:46:58karlcowsetmessages: + msg183660
2013-03-07 13:42:05eli.benderskysetnosy: + eli.bendersky
messages: + msg183658
2013-03-07 13:33:08karlcowsetfiles: + issue-17375-1.patch

nosy: + karlcow
messages: + msg183657

keywords: + patch
2013-03-07 09:24:15rhettingercreate