Skip to content

Add return type hints throughout uxarray #1764

Description

@Sevans711

uxarray has some type hinting in general but the coverage is incomplete, as mentioned in #1763. In many cases return types are missing.

This issue would be fully resolved when all functions have return type annotations… which sounds like a pretty big task. I am guessing it would make sense to break this up into sub-issues, each handling one part of the code, maybe one sub-issue per subpackage (like uxarray/core, uxarray/io, …) or even finer-grained resolution if necessary to make things easier to review?

@rajeeja after looking into the type hints a bit with your post of #1763, do you have any recommendations for what order to prioritize these issues? In particular, does it make sense to add any automated type-checking tests which are sensitive to return type (e.g. --disallow-untyped-defs) before starting on this issue? Or, would it make more sense to do a "best-effort" approach at first, and then test correctness and fix any bugs at the very end?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    improvementImprovements on existing features or infrastructure

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions