graphql-python / graphql-python/graphene

Correct documentation and use of type hints

Abierto
#1,454 1 comentario 6 reacciones 0 asignados Ver en GitHub
✨ enhancement 📖 documentation 🙋 help wanted
Lenguaje dominante
Python
Estrellas
8.2k
Forks
818
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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)

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Comienza revisando los archivos Python afectados y la configuración de la documentación; después, lee los problemas conocidos en #1100 y #1282. Usa sphinx-autodoc-typehints como mecanismo de documentación propuesto; se considera terminado cuando las anotaciones de tipos modernas son la fuente de verdad, se han eliminado las anotaciones duplicadas de la documentación y cada archivo aportado está completo.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
backend-api-design, documentation
Tipo de issue
Refactorización
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
32/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.