Skip to content

Add type hinting in python #1311

@DomFijan

Description

@DomFijan

Description

Many freud classes and functions don't have type hints. Implementing them would help with using IDEs so that users don't have to reference docs all the time.

Proposed Solution

Since we have recently made the port to nanobind, all python files are pure python files so using the full python feature set is possible and IDEs and language servers particularly benefit from type hits for code completion or easy docstring reading.
Type hints should be added such that all function returns and function variables are added according to the latest python standard.

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions