This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author nedbat
Recipients nedbat
Date 2013-12-08.16:46:54
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1386521214.76.0.425352875537.issue19931@psf.upfronthosting.co.za>
In-reply-to
Content
When I make a namedtuple, I get automatic docstrings that use a lot of words to say very little.  Sphinx autodoc produces this:

```
class Key

    Key(scope, user_id, block_scope_id, field_name)

    __getnewargs__()

        Return self as a plain tuple. Used by copy and pickle.

    __repr__()

        Return a nicely formatted representation string

    block_scope_id None

        Alias for field number 2

    field_name None

        Alias for field number 3

    scope None

        Alias for field number 0

    user_id None

        Alias for field number 1
```
The individual property docstrings offer no new information over the summary at the top.   I'd like namedtuple to be not so verbose where it has no useful information to offer.  The one-line summary is all the information namedtuple has, so that is all it should include in the docstring:

```
class Key

    Key(scope, user_id, block_scope_id, field_name)
```
History
Date User Action Args
2013-12-08 16:46:54nedbatsetrecipients: + nedbat
2013-12-08 16:46:54nedbatsetmessageid: <1386521214.76.0.425352875537.issue19931@psf.upfronthosting.co.za>
2013-12-08 16:46:54nedbatlinkissue19931 messages
2013-12-08 16:46:54nedbatcreate