[ python-Bugs-1475554 ] Poorly worded description for socket.makefile()

[SourceForge.net]

Bugs item #1475554, was opened at 2006-04-24 10:19
Message generated for change (Comment added) made by akuchling
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1475554&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: Python 2.4
>Status: Closed
>Resolution: Fixed
Priority: 3
Submitted By: Roy Smith (roysmith)
>Assigned to: A.M. Kuchling (akuchling)
Summary: Poorly worded description for socket.makefile()

Initial Comment:
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.


----------------------------------------------------------------------

>Comment By: A.M. Kuchling (akuchling)
Date: 2006-06-03 14:34

Message:
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!

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1475554&group_id=5470