Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > comp.lang.python > #64917

Documenting descriptors

From "Joseph L. Casale" <jcasale@activenetwerx.com>
Subject Documenting descriptors
Date 2014-01-28 18:43 +0000
Newsgroups comp.lang.python
Message-ID <mailman.6079.1390934642.18130.python-list@python.org> (permalink)

Show all headers | View raw


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

Back to comp.lang.python | Previous | Next | Find similar | Unroll thread


Thread

Documenting descriptors "Joseph L. Casale" <jcasale@activenetwerx.com> - 2014-01-28 18:43 +0000

csiph-web