[Doc-SIG] Python docs in reST
aahz at pythoncraft.com
Wed May 18 18:42:15 CEST 2005
On Wed, May 18, 2005, Skip Montanaro wrote:
> Michael> Yup. One of the biggest problems I've had with autogenerating
> Michael> documentation is that there is usually no way to mark a
> Michael> method/function as private other than the double underscore
> Michael> name mangling (which isn't usually what you want to do).
> Actually, there are two ways:
> * single leading underscore => this attribute is private (this is simply
> a convention based on the "we're all adults here" rubric)
That's two-thirds true: the convention is based on module attributes,
where a single underscore is in fact significatn.
Aahz (aahz at pythoncraft.com) <*> http://www.pythoncraft.com/
"And if that makes me an elitist...I couldn't be happier." --JMS
More information about the Doc-SIG