Documenting descriptors

J

Joseph L. Casale

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
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

Forum statistics

Threads
473,982
Messages
2,570,189
Members
46,736
Latest member
zacharyharris

Latest Threads

Top