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: Poorly worded description for socket.makefile()
Type: Stage:
Components: Documentation Versions: Python 2.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: akuchling Nosy List: akuchling, roysmith
Priority: low Keywords:

Created on 2006-04-24 14:19 by roysmith, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg28337 - (view) Author: Roy Smith (roysmith) Date: 2006-04-24 14:19
On the "7.2.1 Socket Objects" page, under makefile(),
it says "The socket should be in blocking mode". If I
understand it correctly, it MUST be in blocking mode. 
"Must" implies a mandatory requirement, "should"
implies a suggestion of the best way to do something.

This comment applies to many places in the Python docs.
 There should be a comprehensive review of all the docs
to clarify "should" vs. "must" usage.
msg28338 - (view) Author: A.M. Kuchling (akuchling) * (Python committer) Date: 2006-06-03 18:34
Logged In: YES 
user_id=11375

I've corrected the text for makefile() on the 2.4-maint and trunk branches.  
Thanks for the report!
History
Date User Action Args
2022-04-11 14:56:17adminsetgithub: 43271
2006-04-24 14:19:50roysmithcreate