Skip to content

MetaABC and subclasses should include return type hints #308

@wtbarnes

Description

@wtbarnes

It would be helpful to add return type hints to the MetaABC class definitions as well as the associated subclasses. Since there are no/minimal docstrings on these abstract properties, it is difficult to know what they are supposed to be. Adding return type hints would help to resolve that ambiguity.

I fully appreciated we've been reluctant to do any typing on projects maintained by SunPy for reasons (TM). However, in this limited context, I think it is worth doing, mostly to help other developers trying to use these metaclasses as they can effectively act as a metadata standard.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DiscussionAn issue opened for, or undergoing discussion.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions