graphql-python / graphql-python/graphene

Correct documentation and use of type hints

Ouverte
#1,454 1 commentaire 6 réactions 0 personnes assignées Voir sur GitHub
✨ enhancement 📖 documentation 🙋 help wanted
Langage dominant
Python
Étoiles
8.2k
Forks
818
Métriques de merge des PR
Aucune PR mergée en 30 j

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)

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par examiner les fichiers Python concernés et la configuration de la documentation, puis lisez les problèmes connus dans #1100 et #1282. Utilisez sphinx-autodoc-typehints comme mécanisme de documentation proposé ; le travail est considéré comme terminé lorsque les annotations de type modernes constituent la source de vérité, que les annotations dupliquées ont été supprimées de la documentation et que chaque fichier contribué est complet.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
backend-api-design, documentation
Type d'issue
Refactorisation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
32/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.