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

Correct documentation and use of type hints #1454

Open
erikwrede opened this issue Aug 27, 2022 · 1 comment
Open

Correct documentation and use of type hints #1454

erikwrede opened this issue Aug 27, 2022 · 1 comment

Comments

@erikwrede
Copy link
Member

erikwrede commented Aug 27, 2022

We should upgrade graphene to use modern type hints. In that process, type hints should be removed from the class/method documentation to have the code as the single source of truth for typing.
We can use https://github.com/tox-dev/sphinx-autodoc-typehints to automatically add type hints back into the docs.

PRs addressing this issue should at least fix the entire file they are contributing to reduce double-checking effort and streamline the process.

Known issues:
#1100 , see #1282 (Query on schema)

@anentropic
Copy link

This would big a big help to anyone wanting to use graphene in a typed codebase

Because the 3rd party type defs we've been using seem to be abandonware (e.g. trialspark/graphene-stubs#27 and no commits for ~3 years)

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

No branches or pull requests

2 participants