github-tools / github-tools/github
Discrepancy in documentation for GitHub.search()
- Linguagem predominante
- JavaScript
- Estrelas
- 3.8k
- Forks
- 809
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
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.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100