[Twisted-Python] Re: Contributing?
![](https://secure.gravatar.com/avatar/7905d47e9096477130b7055ab70d0f30.jpg?s=120&d=mm&r=g)
I think the single biggest contribution anyone could make to Twisted would be to help document it. It is a brilliantly written but really opaque bunch of code. I think someone who understands what's going on and knows how to write English (not necessarily a programmer) should be given SVN write access for the sole purpose of adding informative docstrings throughout the source. -- Ed Suominen Registered Patent Agent Open Source Developer (Yes, both...) Web Site: http://www.eepatents.com
![](https://secure.gravatar.com/avatar/7ed9784cbb1ba1ef75454034b3a8e6a1.jpg?s=120&d=mm&r=g)
Ed Suominen wrote:
[snip - give someone svn access to contribute documentation]
There is already such a person. She does a great job. I think Twisted's documentation (which is not perfect, but is quite good, despite occassional comments to the contrary) would benefit greatly if the user community contributed improvements to the existing documentation. I'm not talking about any huge task here. If you find a paragraph that is confusingly worded, or a function that is undocumented, and you subsequently figure out how things work, rewrite that paragraph or come up with a doc string and send it to us: http://twistedmatrix.com/bugs/ Jp
![](https://secure.gravatar.com/avatar/d6328babd9f9a98ecc905e1ccac2495e.jpg?s=120&d=mm&r=g)
On Mon, 2004-08-30 at 12:54 -0400, Jp Calderone wrote:
It occurs to me that members of the community periodically write snippets of documentation, then host them elsewhere. Perhaps some of you who have done that could talk to Mary and integrate these efforts with the official documentation?
![](https://secure.gravatar.com/avatar/7ed9784cbb1ba1ef75454034b3a8e6a1.jpg?s=120&d=mm&r=g)
Ed Suominen wrote:
[snip - give someone svn access to contribute documentation]
There is already such a person. She does a great job. I think Twisted's documentation (which is not perfect, but is quite good, despite occassional comments to the contrary) would benefit greatly if the user community contributed improvements to the existing documentation. I'm not talking about any huge task here. If you find a paragraph that is confusingly worded, or a function that is undocumented, and you subsequently figure out how things work, rewrite that paragraph or come up with a doc string and send it to us: http://twistedmatrix.com/bugs/ Jp
![](https://secure.gravatar.com/avatar/d6328babd9f9a98ecc905e1ccac2495e.jpg?s=120&d=mm&r=g)
On Mon, 2004-08-30 at 12:54 -0400, Jp Calderone wrote:
It occurs to me that members of the community periodically write snippets of documentation, then host them elsewhere. Perhaps some of you who have done that could talk to Mary and integrate these efforts with the official documentation?
participants (4)
-
Ed Suominen
-
Glyph Lefkowitz
-
Jp Calderone
-
Phil Hunt