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


Groups > comp.lang.python > #64917

Documenting descriptors

Path csiph.com!usenet.pasdenom.info!aioe.org!news.stack.nl!newsfeed.xs4all.nl!newsfeed2a.news.xs4all.nl!xs4all!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail
Return-Path <jcasale@activenetwerx.com>
X-Original-To python-list@python.org
Delivered-To python-list@mail.python.org
X-Spam-Status OK 0.019
X-Spam-Evidence '*H*': 0.96; '*S*': 0.00; 'here?': 0.09; 'input,': 0.09; 'parameter': 0.09; 'sphinx': 0.09; 'descriptors.': 0.16; 'received:172.18.0': 0.16; 'thanks,': 0.17; '(not': 0.18; 'to:name :python-list@python.org': 0.22; 'header:Received:8': 0.24; 'properties': 0.29; 'doc': 0.31; 'documenting': 0.31; 'markup': 0.31; 'anyone': 0.31; 'classes': 0.35; 'but': 0.35; 'really': 0.36; 'var': 0.36; 'charset:us-ascii': 0.36; 'to:addr:python- list': 0.38; 'to:addr:python.org': 0.39; 'called': 0.40; 'received:unknown': 0.61; 'utilize': 0.61
X-Cloudmark-SP-Filtered true
X-Cloudmark-SP-Result v=1.1 cv=UbGOdjJMTOnDdlSKs4VLEv47Nwxh2hlhayjdFxkzNJk= c=1 sm=1 a=7PYXob_7ZXMA:10 a=P90J6pEA2ccA:10 a=BLceEmwcHowA:10 a=kj9zAlcOel0A:10 a=xqWC_Br6kY4A:10 a=oNw28mxuUhXRB3mVwYQ4Ag==:17 a=R0xn94zBBm73NsdXi-YA:9 a=CjuIK1q_8ugA:10 a=17GW5T2bjR0A:10 a=xEJwoPLTjEwA:10 a=HpAAvcLHHh0Zw7uRqdWCyQ==:117
DKIM-Signature v=1; a=rsa-sha256; c=relaxed/simple; d=activenetwerx.com; s=default; t=1390934634; bh=Q94bJrmh11I0IaTne70p3nTBoxnHZRacTbKK8BzlKGk=; h=From:To:Subject:Date; b=iz+3rFGA4TgNJbotsjaTgRC6ItWZomLi5a//iFDRzuxWLAxJTXj8k7iEFQKTrykXu x/Jt5bLTr4PUJEw3xjD8/7zO+5xj1U753QljX3PJAkduidbWYDN+UJJkB0ns/PNXiW cU5XM81FPH7ATsSJxi8f4TbZHn6vAOxufq/xX6j8=
DKIM-Signature v=1; a=rsa-sha256; c=relaxed/simple; d=activenetwerx.com; s=default; t=1390934634; bh=Q94bJrmh11I0IaTne70p3nTBoxnHZRacTbKK8BzlKGk=; h=From:To:Subject:Date; b=iz+3rFGA4TgNJbotsjaTgRC6ItWZomLi5a//iFDRzuxWLAxJTXj8k7iEFQKTrykXu x/Jt5bLTr4PUJEw3xjD8/7zO+5xj1U753QljX3PJAkduidbWYDN+UJJkB0ns/PNXiW cU5XM81FPH7ATsSJxi8f4TbZHn6vAOxufq/xX6j8=
X-Spam-Checker-Version SpamAssassin 3.3.1 (2010-03-16) on mail.activenetwerx.com
X-Spam-Level
X-Spam-Status No, score=-1.0 required=5.0 tests=ALL_TRUSTED autolearn=ham version=3.3.1
From "Joseph L. Casale" <jcasale@activenetwerx.com>
To "python-list@python.org" <python-list@python.org>
Subject Documenting descriptors
Thread-Topic Documenting descriptors
Thread-Index AQHPHFhwxlbpoXSRbkKyaf6+tCMVlg==
Date Tue, 28 Jan 2014 18:43:52 +0000
Accept-Language en-US
Content-Language en-US
X-MS-Has-Attach
X-MS-TNEF-Correlator
x-originating-ip [172.18.0.4]
Content-Type text/plain; charset="us-ascii"
Content-Transfer-Encoding quoted-printable
MIME-Version 1.0
X-Virus-Scanned ClamAV using ClamSMTP
X-BeenThere python-list@python.org
X-Mailman-Version 2.1.15
Precedence list
List-Id General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe <https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive <http://mail.python.org/pipermail/python-list/>
List-Post <mailto:python-list@python.org>
List-Help <mailto:python-list-request@python.org?subject=help>
List-Subscribe <https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups comp.lang.python
Message-ID <mailman.6079.1390934642.18130.python-list@python.org> (permalink)
Lines 15
NNTP-Posting-Host 2001:888:2000:d::a6
X-Trace 1390934642 news.xs4all.nl 2922 [2001:888:2000:d::a6]:43748
X-Complaints-To abuse@xs4all.nl
Xref csiph.com comp.lang.python:64917

Show key headers only | 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