microsoft / microsoft/node-api-dotnet

Documentation is wrong and examples don't build

Offen
#439 2 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
C#
Sterne
783
Forks
80
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

trying to build examples/jsdom gives

Restore complete (0.6s)
  jsdom failed with 1 error(s) (0.3s)
    error CS1729: 'NodeEmbeddingPlatform' does not contain a constructor that takes 2 arguments

And trying to follow the instructions for CS calling Node https://microsoft.github.io/node-api-dotnet/scenarios/dotnet-js.html indeed shows that

NodeEmbeddingPlatform nodejsPlatform = new(libnodePath, null);

is wrong, I think it is supposed to look like this:

NodeEmbeddingPlatform nodejsPlatform = new(new NodeEmbeddingPlatformSettings { LibNodePath = libnodePath});

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Das fehlschlagende Beispiel befindet sich in examples/jsdom, und die gemeldete Anleitung ist die CS calling Node-Seite unter der verlinkten URL. Beginne damit, die Konstruktion von NodeEmbeddingPlatform im Beispiel und in der Dokumentation mit der gezeigten NodeEmbeddingPlatformSettings-Form zu vergleichen. Erledigt ist die Aufgabe, wenn das Beispiel erstellt werden kann und die Dokumentation der aktuellen API entspricht.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, node.js
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.