Skip to content

Unify properties getter, setters and deleters under a single documentation entry #587

@tristanlatr

Description

@tristanlatr

It would good to see all the information about a property inside a single documentation entry.

The main issue is what to do if several object have docstrings assigned to ? Should they be merge them together? Should we display them in separate boxes?

Or maybe we should log a warning an use only the getter docstring. This would be the most simple solution and also comply with the default behavior of help(), but we’ve been using docstring on property setter in our demo. So we should probably look at a way of still supporting that.

Anyway the information whether this property is writable or deletable or read only can be added as extra_info.

Metadata

Metadata

Assignees

No one assigned

    Labels

    astbuilderA substantive change is required in the astbuilder flow in order to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions