Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#678 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
documentation, testing-qa

调研方向

先从 docs/pages/future.rst、docs/pages/contrib/hypothesis_plugins.rst 和 docs/pages/context.rst 中的三个示例开始，然后检查 tests/test_docs。将示例移到该测试区域，用 literalinclude 指令和源代码链接替换它们，并仅在需要时更新 pyproject.toml 或 docs/requirements.txt。运行 flake8、mypy 和 pytest；示例已被包含、链接并正常工作即表示完成。

由索引模型根据 Issue 内容生成。

描述

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! 📖

主要语言
Python
星标
4.4k
派生
154
平均合并
3 小时 5 分钟
30 天内合并 PR
22

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

dry-python/returns 的其他 Issue

查看 dry-python/returns 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。