Detailed documentation on Proxy by adding docstrings to many of the methods.

	zimmer reported
Trac ID	trac#5513
Type	enhancement
Created	2012-03-07 04:57:45Z
Branch	https://github.com/twisted/twisted/tree/proxy-docs-5513

The Proxy classes in proxy.py have either no docstring or generic simple ones that don't really help someone who is using it for the first time... I have added more detailed docstrings that hopefully help people who want to use twisted for proxies (as I did/do).

Basically the proxy.py documentation is sorely missing and hopefully this is a step on improving it.

Attachments:

• my-twisted-patch.patch (7499 bytes) - added by zimmer on 2012-03-07 04:58:24Z - .patch that shows the added docstrings
• proxydocs2.patch (7498 bytes) - added by zimmer on 2012-03-08 04:00:04Z - Fixed proxy doc strings

trac-id__5513 5513
type__enhancement enhancement
reporter__zimmer zimmer
priority__normal normal
milestone__ 
branch__branches_proxy_docs_5513 branches/proxy-docs-5513
branch_author__zimmer__thijs zimmer, thijs
status__new new
resolution__None None
component__web web
keywords__documentation documentation
time__1331096265000000 1331096265000000
changetime__1376983098000000 1376983098000000
version__None None
owner__tom_prince tom.prince
cc__jknight cc__zimmer

Start with proxy.py and review the Proxy classes whose docstrings are missing or generic. Compare the attached proxydocs2.patch and the proxy-docs-5513 branch, then ensure the relevant methods have detailed documentation suitable for first-time users of Twisted proxies.