B2 SDK docs: convert embedded TODO directives into tracked documentation issues
维护者通常 1 天内回复
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 22/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
调研方向
Start with the todo:: and TODO:: directives in doc/source/index.rst, advanced.rst and doc/source/api, and with how doc/source/conf.py gates them behind B2_SPHINX_TODO. Classify each entry as obsolete, documentation work, API design or deferred. The work is already claimed by open pull request #603, so check that thread before starting. Done means every TODO is removed or linked to a focused issue.
由索引模型根据 Issue 内容生成。
描述
Description
Several Sphinx pages contain embedded todo directives for missing explanations, raw-simulator coverage, list consistency, exception documentation, progress documentation, and an advanced-API design concern. doc/source/conf.py only includes them when B2_SPHINX_TODO is enabled. In the normal published build they are invisible, and they carry no owner, priority, acceptance criteria, or discussion history.
Steps to reproduce
1. Search doc/source/index.rst, advanced.rst, and doc/source/api for `todo::` or `TODO::`.
2. Build the documentation without B2_SPHINX_TODO enabled.
3. Observe that the pending work is absent from the normal output and is not linked to tracked issues.
Expected behavior
Review each TODO and classify it as obsolete, documentation work, API design work, or intentionally deferred. Remove obsolete entries, create focused issues for actionable work, and replace any retained source TODO with a link to its issue and a reason it remains useful in the source.
Actual behavior
Maintenance work is hidden inside source files and can remain unnoticed indefinitely. Some TODOs describe user-facing documentation gaps, while another describes a possible API change; keeping them together without tracking also obscures different owners and compatibility risks.
Environment
- Python version: Not applicable
- b2sdk version:
masteratf3ab7b71 - OS: Not applicable
- 主要语言
- Python
- 星标
- 214
- 派生
- 68
- 平均合并
- 51 分钟
- 30 天内合并 PR
- 6
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
Backblaze/b2-sdk-python 的其他 Issue
-
Download and copy sync actions print remote file names without escape_control_chars可能已有人在做 @dreyfus92 于 15 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
Backblaze/b2-sdk-python#631 ·
维护者通常 1 天内回复
-
SqliteAccountInfo profile name validation uses "re.match", so only the first character is checked可能已有人在做 @nazarli-shabnam 于 9 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
Backblaze/b2-sdk-python#629 ·
维护者通常 1 天内回复
-
Adopt the AI-native SDLC and repository policies可能已有人在做 @goanpeca 于 18 天前认领。 未关闭enhancement
难度 5/5 一周以上 新手友好度 20/100
Backblaze/b2-sdk-python#634 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 50/100
Backblaze/b2-sdk-python#630 ·
维护者通常 1 天内回复
-
ci: cli-compat fails — 4 sse/sync integration tests broken in B2_Command_Line_Tool (all environments)可能重新可做 @ffumero2003 于 37 天前认领，目前没有进行中的 PR。 未关闭bug testing
Backblaze/b2-sdk-python#627 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 Backblaze/b2-sdk-python 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 72/100
btclib-org/btclib-node#2505 · 1 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
open-webui/open-webui#34462 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
gorakhargosh/watchdog#1462 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
openwisp/openwisp-monitoring#889 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
IETF-Hackathon/pqc-certificates#351 ·
维护者通常 2 天内回复