Skip to content

Doc: implement grpc properties as both parameter and attribute #267

@greschd

Description

@greschd

In #265, we're adding a doc parameter to the grpc_data_property wrappers, to set the docstring on the properties. However, to avoid duplication of the docstring itself it's only set on read-only properties (where the same information doesn't need to be specified in the Parameters section of the __init__ docstring.

We should find a way to de-duplicate this information while still documenting it both on the property itself, and in the Parameters. Probably, the Parameters section can be auto-generated from the property docstrings.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfeatureNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions