conflictGet docs has wrong return type
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 48/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- git, javascript, node.js
调研方向
从链接的 nodegit.org API 页面上的 Index.conflictGet 文档开始，并将其中说明的返回类型与 issue 1193 进行比较。更新文档，以描述包含 ancestor_out、our_out 和 their_out 这几个 IndexEntry 值的对象，其中每个值都可以为 nullable；修正后的 API 参考文档即为完成条件。
由索引模型根据 Issue 内容生成。
描述
The documentation of Index.conflictGet (here for example: https://www.nodegit.org/api/index/#conflictGet) has the wrong return value: it doesn't return a single IndexEntry, but an object with this type:
{
ancestor_out: IndexEntry | null
our_out: IndexEntry | null
their_out: IndexEntry | null
}
See this issue for referenece as well: https://github.com/nodegit/nodegit/issues/1193
- 主要语言
- JavaScript
- 星标
- 5.8k
- 派生
- 704
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
nodegit/nodegit 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 45/100
-
难度 4/5 3-5 天 新手友好度 45/100
-
难度 4/5 3-5 天 新手友好度 35/100
-
难度 4/5 3-5 天 新手友好度 35/100
-
难度 5/5 一周以上 新手友好度 25/100
相似的 Issue
-
Edit: CW+ 未关闭channels:edit check:passed
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 78/100
idean3885/claude-ops-agent#521 ·
-
forespørsel 🥰 ikoner 🖼 nytt ✨
难度 2/5 1-3 小时 新手友好度 68/100
-
bug
难度 2/5 1-3 小时 新手友好度 76/100
avniproject/avni-client#2135 ·
-
automated broken-link
难度 1/5 1 小时以内 新手友好度 85/100