homepage

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.

Author thread13
Recipients docs@python, thread13
Date 2012年05月16日.00:49:15
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1337129357.09.0.399271723054.issue14823@psf.upfronthosting.co.za>
In-reply-to
Content
Hi there,
I suggest to improve the description of Lock.acquire()
[ http://docs.python.org/library/threading.html#threading.Lock.acquire ]
in the following way:
>>>>> current version >>>>>
Lock.acquire([blocking])
 Acquire a lock, blocking or non-blocking.
 When invoked without arguments, block until the lock is unlocked,
 then set it to locked, and return true.
 When invoked with the *blocking* argument set to true, do the same
 thing as when called without arguments, and return true.
 When invoked with the *blocking* argument set to false, do not
 block. If a call without an argument would block, return false
 immediately; otherwise, do the same thing as when called without
 arguments, and return true.
<<<<< current version <<<<<
>>>>> suggested version >>>>>
Lock.acquire([blocking])
 Acquire a lock, blocking or non-blocking.
 When invoked with the *blocking* argument set to true 
 (the default), block until the lock is unlocked, 
 then set it to locked, and return true.
 When invoked with the *blocking* argument set to false, do not
 block. If a call without an argument would block, return false
 immediately; otherwise, set the lock to locked, and return true.
<<<<< suggested version <<<<<
The idea is to simplify the structure of the explanation: get rid of an unnecessary "goto" -- "do the same thing as" as well as the extra branching ("when invoked without arguments" ... "when invoked with *blocking* argument set to true") .
The suggested patch for the text version of the documentation ( http://docs.python.org/download.html -> http://docs.python.org/archives/python-2.7.3-docs-text.tar.bz2 ) is attached. 
PS. I did not dare to capitalize the boolean variables ("true" -> "True") to adhere to the general style of the document (obviously inherited from Java). For the same reason I didn't either change the argument signature from "[blocking]" to "[blocking=True]".
History
Date User Action Args
2012年05月16日 00:49:17thread13setrecipients: + thread13, docs@python
2012年05月16日 00:49:17thread13setmessageid: <1337129357.09.0.399271723054.issue14823@psf.upfronthosting.co.za>
2012年05月16日 00:49:16thread13linkissue14823 messages
2012年05月16日 00:49:15thread13create

AltStyle によって変換されたページ (->オリジナル) /