[issue8937] SimpleHTTPServer should contain usage example

anatoly techtonik report at bugs.python.org
Thu Jun 17 13:55:44 CEST 2010


anatoly techtonik <techtonik at gmail.com> added the comment:

Thank you. The wording can surely be improved, but it is much better than nothing. 

I'd reword the first para further:

> The :func:`test` function in the :mod:`SimpleHTTPServer` module is an example of using :class:`SimpleHTTPRequestHandler` with :class:`BaseHTTPServer` class.

BTW, it is still bad, because:
1. I'd assume that test function is described in documentation and not located in module source
2. users usually don't know where to look for the module source - doc should be self-sufficient
3. SimpleHTTPServer.test() is a proxy call for BaseHTTPServer.test()

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8937>
_______________________________________


More information about the Python-bugs-list mailing list