Incorrect documentation for BlameHunk
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
从 https://www.nodegit.org/api/blame_hunk/ 的 BlameHunk 文档开始，追踪其 API 文档的生成方式。检查相同的分类是否会影响其他已记录文档的对象，然后更新生成器或文档源，使返回函数的字段列为类方法，并验证受影响的页面。
由索引模型根据 Issue 内容生成。
描述
The documentation for BlameHunk at https://www.nodegit.org/api/blame_hunk/ lists all fields as "instance variables".
None of them are instance variables of the specified type. All of them are functions returning the specified type.
The documentation should list them as class methods.
There are a number of other objects besides BlameHunk that have this same error, so I'm presuming it's a consequence of how the documentation is generated.
- 主要语言
- 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