Update documentation to use generators
@aashraybhandar1 已经在做这个了。
开始于 2018年4月7日。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
- 领域
- cli, documentation
调研方向
首先阅读 quick-start 和 API 文档中将 CLI Helpers 的输出描述为列表的部分。更新这些引用,使其描述生成器,然后验证两个文档区域都一致地反映当前行为。
由索引模型根据 Issue 内容生成。
描述
The current documentation assumes that the output format is a list, but CLI Helpers now returns generators. We should update the quick start and the API documentation.
- 主要语言
- Python
- 星标
- 104
- 派生
- 33
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
dbcli/cli_helpers 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 45/100
dbcli/cli_helpers#50 · 2 条评论 ·
查看 dbcli/cli_helpers 的全部 Issue
相似的 Issue
-
needs triage
难度 2/5 1-3 小时 新手友好度 83/100
darnitdevorg/darnit#587 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 67/100
维护者通常 1 天内回复
-
accessibility good first issue
难度 1/5 1-3 小时 新手友好度 92/100
维护者通常 1 天内回复
-
llm translation
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
bug bug-hunt
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复