conflictGet docs has wrong return type

Offen

#1,984 erstellt am 21.7.2023 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 2/5
Geschätzter Aufwand: 1-3 Stunden
Anfängerfreundlichkeit: 48/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: git, javascript, node.js
Bereich: documentation

Rechercherichtung

Beginne mit der Dokumentation von Index.conflictGet auf der verlinkten nodegit.org-API-Seite und vergleiche ihren angegebenen Rückgabetyp mit Issue 1193. Aktualisiere die Dokumentation so, dass sie das Objekt beschreibt, das die jeweils nullable IndexEntry-Werte ancestor_out, our_out und their_out enthält; die korrigierte API-Referenz ist die Erledigungsbedingung.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

The documentation of Index.conflictGet (here for example: https://www.nodegit.org/api/index/#conflictGet) has the wrong return value: it doesn't return a single IndexEntry, but an object with this type:

{
 ancestor_out: IndexEntry | null
 our_out: IndexEntry | null
 their_out: IndexEntry | null
}

See this issue for referenece as well: https://github.com/nodegit/nodegit/issues/1193

Vorherrschende Sprache: JavaScript
Sterne: 5.8k
Forks: 704
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus nodegit/nodegit

Lots of deprecations when installing Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

nodegit/nodegit#2042 · Erstellt am 18.9.2026
DiffLine.rawContent() returns string instead of Buffer, causing non-UTF-8 encoding corruption Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

nodegit/nodegit#2038 · Erstellt am 13.1.2026
undefined symbol: EVP_des_ede3_cbc Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

nodegit/nodegit#2037 · 2 Kommentare · Erstellt am 19.12.2025
Linux ARM appears to have a memory handling bug Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

nodegit/nodegit#2024 · Erstellt am 17.10.2025
Prebuilt Binaries for node 22 Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

nodegit/nodegit#2015 · 8 Kommentare · 4 Reaktionen · Erstellt am 10.2.2025

Alle Issues in nodegit/nodegit