graphql-python / graphql-python/graphene
Correct documentation and use of type hints
- Vorherrschende Sprache
- Python
- Sterne
- 8.2k
- Forks
- 818
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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)
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne mit der Durchsicht der betroffenen Python-Dateien und der Dokumentationskonfiguration und lies anschließend die bekannten Probleme in #1100 und #1282. Verwende sphinx-autodoc-typehints als vorgeschlagenen Dokumentationsmechanismus; als abgeschlossen gilt die Arbeit, wenn moderne Type Hints die maßgebliche Quelle sind, doppelte Hinweise aus der Dokumentation entfernt wurden und jede beigetragene Datei vollständig ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- backend-api-design, documentation
- Issue-Typ
- Refactoring
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 32/100