Re: Documenting properties

2005-09-27 Thread Gerrit Holl
Paul McNett wrote: > > Whatever is preferred, what's the upside/downsides of the two beyond > > what I just explained? > > Nothing really, but something handy to keep in mind is that the string > literal ("""x""") can be used to block out huge sections of code during > testing, where you'd have to

Re: Documenting properties

2005-09-27 Thread Paul McNett
Lasse Vågsæther Karlsen wrote: > So, my question is, is there a way to get __doc__ support for > properties, in effect, use the """xxx""" syntax for documenting properties. Yes, the property() function accepts a doc argument, as in: property(fget, fset, fd

Documenting properties

2005-09-27 Thread Lasse Vågsæther Karlsen
then classname.close.__doc__ shows the text. So, my question is, is there a way to get __doc__ support for properties, in effect, use the """xxx""" syntax for documenting properties. Is the preferred way to use """xxx""" or # to doc