Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add type hinting in python #1311

Open
DomFijan opened this issue Feb 13, 2025 · 0 comments
Open

Add type hinting in python #1311

DomFijan opened this issue Feb 13, 2025 · 0 comments
Labels
enhancement New feature or request essential

Comments

@DomFijan
Copy link
Contributor

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

@DomFijan DomFijan added enhancement New feature or request essential labels Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request essential
Projects
None yet
Development

No branches or pull requests

1 participant