Doc string parameter documentation

[Gustavo Niemeyer]

> We've seem to grown a few different incompatible ways of documenting parameters
> in code. Originally we were using twisted's pydoctor syntax, but we since
> migrated to using sphinx for documentation.
>
> We should use one style consistently. Given our usage of sphinx, I think all
> parameter documentation references should be cleaned up to use its style as we
> go.

I'm personally happy with any format as long as we're consistent.
Given our use of Sphinx, your proposal sounds good too.  +1!

-- 
Gustavo Niemeyer
http://niemeyer.net
http://niemeyer.net/plus
http://niemeyer.net/twitter
http://niemeyer.net/blog

-- I never filed a patent.