github-tools / github-tools/github
Discrepancy in documentation for GitHub.search()
- Lingua principale
- JavaScript
- Stelle
- 3.8k
- Fork
- 809
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100