github-tools / github-tools/github

Discrepancy in documentation for GitHub.search()

Open
#449 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
3.8k
Forks
809
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.