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: SocketServer module documentation misleading
Type: Stage:
Components: Documentation Versions: Python 2.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, georg.brandl, jongiddy
Priority: normal Keywords:

Created on 2004-05-20 16:42 by jongiddy, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg20858 - (view) Author: Jon Giddy (jongiddy) Date: 2004-05-20 16:42
The Python Library Reference page for the SocketServer
module refers to RequestHandlerClass as though it was
the name of an actual class. Actually, it should be
either "request handler class" or "BaseRequestHandler".

Secondly, in the second para of the BaseRequestHandler
handle() method description, StreamRequestHandler and
DatagramRequestHandler are referred to as mix-in
classes when they are in fact subclasses of
BaseRequestHandler.

This error is also present in the comments at the start
of the module.
msg20859 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2005-07-18 07:39
Logged In: YES 
user_id=1188172

Thanks for the suggestions. Your first point has already
been clarified by adding more explanation to the docs, the
second point I have corrected in
Doc/lib/libsocksvr.tex r1.20, r1.18.4.2, Lib/SocketServer.py
r1.40, r1.37.4.1.
History
Date User Action Args
2022-04-11 14:56:04adminsetgithub: 40278
2004-05-20 16:42:16jongiddycreate