github-tools / github-tools/github
Discrepancy in documentation for GitHub.search()
- Vorherrschende Sprache
- JavaScript
- Sterne
- 3.8k
- Forks
- 809
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Vergleiche das in lib/GitHub.js dokumentierte Argument für GitHub.search() mit dem vom Search-Konstruktor in lib/Search.js erwarteten Objekt. Bestätige die beabsichtigte Schnittstelle und aktualisiere die Dokumentation so, dass sie übereinstimmt. Überprüfe anschließend, dass der Search-Einstiegspunkt keine ungültige Argumentstruktur mehr präsentiert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100