graphql-python / graphql-python/graphene
Correct documentation and use of type hints
Open
✨ enhancement
📖 documentation
🙋 help wanted
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 818
- PR merge metrics
- No merged PRs in 30d
Description
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)
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.