[Python-Dev] Best way to specify docstrings for member objects

Ethan Furman ethan at stoneleaf.us
Wed Mar 20 18:24:03 EDT 2019

On 03/19/2019 11:55 AM, Raymond Hettinger wrote:

> I'm working on ways to make improve help() by giving docstrings
>  to member objects.


> There's another way I would like to propose.  The __slots__
>  definition already works with any iterable including a
>  dictionary (the dict values are ignored), so we could use the
>  values for the  docstrings.
> [...]
> What do you all think about the proposal?

This proposal only works with objects defining __slots__, and only the objects in __slots__?  Does it help Enum, dataclasses, or other enhanced classes/objects?


More information about the Python-Dev mailing list