[docs] Improve socketserver doc (issue 15608)

berker.peksag at gmail.com berker.peksag at gmail.com
Sun Feb 1 06:02:05 CET 2015


http://bugs.python.org/review/15608/diff/13802/Doc/library/socketserver.rst
File Doc/library/socketserver.rst (right):

http://bugs.python.org/review/15608/diff/13802/Doc/library/socketserver.rst#newcode16
Doc/library/socketserver.rst:16: .. class:: TCPServer
Could you please document its constructor, too?

http://bugs.python.org/review/15608/diff/13802/Doc/library/socketserver.rst#newcode36
Doc/library/socketserver.rst:36: For more details on network
programming, consult a book such as
I'd remove this paragraph.

http://bugs.python.org/review/15608/diff/13802/Doc/library/socketserver.rst#newcode104
Doc/library/socketserver.rst:104: class
ThreadingUDPServer(ThreadingMixIn, UDPServer): pass
    class ThreadingUDPServer(ThreadingMixIn, UDPServer):
        pass

http://bugs.python.org/review/15608/diff/13802/Doc/library/socketserver.rst#newcode112
Doc/library/socketserver.rst:112: ForkingUDPServer
    .. class:: ForkingTCPServer
               ForkingUDPServer
               ...

http://bugs.python.org/review/15608/diff/13802/Doc/library/socketserver.rst#newcode353
Doc/library/socketserver.rst:353: .. method:: BaseRequestHandler.setup()
Please indent this and rest of the method. That way you won't need to
add "RequestHandler." to method names:

    .. class:: BaseRequestHandler

       [...]

       .. method:: setup()

          [...]

http://bugs.python.org/review/15608/


More information about the docs mailing list