github-tools / github-tools/github
Discrepancy in documentation for GitHub.search()
- 主要语言
- JavaScript
- 星标
- 3.8k
- 派生
- 809
- PR 合并指标
- 30 天内没有已合并 PR
描述
In [lib/GitHub.js](https://github.com/github-tools/github/blob/22b889cd48cd281812b020d85f8ea502af69ddfd/lib/GitHub.js#L97), the argument for `GitHub.search()` is a string, `query`.
This gets passed to the `Search` constructor, which takes an object [as per here](https://github.com/github-tools/github/blob/master/lib/Search.js#L18). I think I tried this awhile back and it was throwing errors as a result.
贡献指南
这个仓库没有索引到贡献指南
调研方向
Compare the GitHub.search() argument documented in lib/GitHub.js with the object expected by the Search constructor in lib/Search.js. Confirm the intended interface and update the documentation so it matches, then verify the search entry point no longer presents an invalid argument shape.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100