graphql-python / graphql-python/graphene
Correct documentation and use of type hints
Aperta
✨ enhancement
📖 documentation
🙋 help wanted
- Lingua principale
- Python
- Stelle
- 8.2k
- Fork
- 818
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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)
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Valutazione
Questa issue non è ancora stata valutata.