Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Generate proper documentation

Abierto
  • ¿Algo no está bien?
#214 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza revisando README.md y CHANGELOG.md y, a continuación, compara la configuración actual de la documentación del proyecto con el flujo de trabajo de ReadTheDocs y Sphinx mencionado que usa Trio. Define la estructura de la documentación, el enfoque para los hipervínculos y el tratamiento de los mensajes de error antes de realizar cambios; el trabajo estará terminado cuando la información del proyecto y las indicaciones sobre los códigos de error estén organizadas y los enlaces o contenidos generados sigan siendo mantenibles.

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

Descripción

documentation prioritized

README.md has grown to 200 lines, and spans error codes, installation & run instructions, configuration and command-line flags. We also have CHANGELOG.md with 150 lines.
There are a few links in the readme, but it would probably be quite useful to have anything referring to [objects within] urllib3, httpx, anyio, asyncio, trio, etc be hyperlinks w/o having to manually update.
Pulling out the error messages for the documentation automatically would be nice, but somewhat complicated given the current setup for messages differing for different (combinations of) libraries. Should be quite doable though.

https://github.com/python-trio/flake8-async/issues/211#issuecomment-1971778351

I'm planning to write up some more detail about each of our error codes in a long doc, hopefully this weekend, which will include much more about why you'd want to enable each of the optional rules in addition to the existing material.

This also sounds like great doc material.

The one workflow I'm decently accustomed to is ReadTheDocs+Sphinx as used in python-trio/trio, and probably nice to be consistent with it since it's in the same organization. But it's also been a huge pain to work with at times.

Lenguaje dominante
Python
Estrellas
26
Forks
10
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de python-trio/flake8-async

Todos los issues de python-trio/flake8-async

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.