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

Move several examples from the docs to tests and then `literalinclude` them

Abierto
#678 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation, testing-qa

Línea de trabajo

Comienza con los tres ejemplos de docs/pages/future.rst, docs/pages/contrib/hypothesis_plugins.rst y docs/pages/context.rst, y después inspecciona tests/test_docs. Mueve los ejemplos a esa área de pruebas, sustitúyelos por directivas literalinclude y enlaces a las fuentes, y actualiza pyproject.toml o docs/requirements.txt solo si es necesario. Ejecuta flake8, mypy y pytest; se considera terminado cuando los ejemplos estén incluidos, enlazados y funcionando.

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

Descripción

documentation enhancement good first issue hacktoberfest help wanted

We have several quite large examples that live in our docs:

  1. https://github.com/dry-python/returns/blob/master/docs/pages/future.rst#futureresult
  2. Number example from: https://github.com/dry-python/returns/blob/master/docs/pages/contrib/hypothesis_plugins.rst#check_all_laws
  3. https://github.com/dry-python/returns/blob/master/docs/pages/context.rst#requirescontextfutureresult-container

What needs to be done?

  • We need to extract these examples from docs to tests/test_docs folder
  • Instead, we should add this:
.. literalinclude:: ../../tests/test_docs/test_${SOME_NEW_FILENAME}.py
   :linenos:
  • Provide a link to the source code on github somewhere near the example itself
  • Possibly we would need to add some dev-dependencies to both pyproject.toml and docs/requirements.txt
  • Make sure that it is checked by flake8, mypy, and pytest. And that it actually works.

This way we would have nice, complex, but working examples! 📖

Lenguaje dominante
Python
Estrellas
4.4k
Forks
154
Merge medio
3 h 5 min
PR fusionados (30 d)
22

Guía de contribución

Abrir la guía de contribución

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 dry-python/returns

Todos los issues de dry-python/returns

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.