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.

Sign up for GitHub

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

Jump to bottom

Add type hints everywhere #974

Open
jgostick opened this issue Jul 8, 2024 · 2 comments
Open

Add type hints everywhere #974

jgostick opened this issue Jul 8, 2024 · 2 comments

Comments

@jgostick
Copy link
Member

jgostick commented Jul 8, 2024

Including default values and lists of options, when applicable.
@jgostick
Copy link
Member Author

I'm a bit torn on this actually. I guess they're a good idea, and are necessary for the GUI prototype, but they really clutter up the code and make the docstring look horrendous.

@ma-sadeghi
Copy link
Member

We can only add type hints to args, and use sphinx-autodoc-typehints to propagate to docstrings when generating the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jgostick @ma-sadeghi