mardi 28 janvier 2014

Documenting descriptors topic




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





Aucun commentaire:

Enregistrer un commentaire