ConvenientPatch#hunks documentation is incorrect
未关闭
还没有人认领这个 Issue。
- 主要语言
- JavaScript
- 星标
- 5.8k
- 派生
- 704
- PR 合并指标
- 30 天内没有已合并 PR
描述
The documentation at https://www.nodegit.org/api/convenient_patch/#hunks indicates that the return of hunks is an Array<ConvenientHunk>.
However, there is no such type as ConvenientHunk. It is not clear what hunks() actually returns.
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
先从链接的 API 页面上的 ConvenientPatch#hunks 文档开始，然后找到 hunks() 的实现或 API 定义，以确定其实际返回类型。更新文档以使用正确的类型，并确认生成的 API 页面不再引用 ConvenientHunk。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100