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

Rather outdated docs on RTD

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

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
documentation

调研方向

首先检查 Read the Docs 配置以及 issue 中链接的 API 页面对应的文档源,然后将其与 changelog 和当前项目名称进行比较。确认文档构建的配置方式,并更新已发布的文档,以体现新的解压选项和当前名称。

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

描述

I just had a look at the docs to see whether decompressing would allow specifying an output limit, which did not appear to be the case: https://python-hyper.org/projects/brotlipy/en/latest/api.html#brotli.Decompressor.decompress

According to the changelog, this has been changed and released a few days ago, but according to the build history, the RTD docs have not been generated for over seven years, thus these new options are missing: https://app.readthedocs.org/projects/brotlipy/builds/

By the way: The docs seem to still be under the old name which has been changed a few years ago, which is a bit confusing as well.

主要语言
Python
星标
155
派生
35
平均合并
8 天 9 小时
30 天内合并 PR
1

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

python-hyper/brotlicffi 的其他 Issue

查看 python-hyper/brotlicffi 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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