Documenting descriptors

Joseph L. Casale jcasale at activenetwerx.com
Tue Jan 28 13:43:52 EST 2014


I am documenting a few classes with Sphinx that utilize methods decorated
with custom descriptors. These properties return data when called and Sphinx
is content with a :returns: and :rtype: markup in the properties doc string.

They also accept input, but parameter (not really applicable) nor var markup
is accepted as valid?

Anyone know the trick here?

Thanks,
jlc


More information about the Python-list mailing list