emscripten-core / emscripten-core/emscripten

Documentation about Module.arguments may need to be improved

Offen
#21,082 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C++
Sterne
27.6k
Forks
3.6k
Ø Merge
1 T. 14 Std.
Gemergte PRs (30 T.)
125

Beschreibung

The current documentation about `Module.arguments` is not clear enough, see [doc](https://emscripten.org/docs/api_reference/module.html#affecting-execution). You will receive "undefined" if you use `Module.arguments` straight in prejs because the documentation doesn't indicate that you should initialize it first, for example:
```
Module['arguments'].push("-k");
Module['arguments'].push("Image");
Module['arguments'].push("-b");
Module['arguments'].push("minimal.dtb");
Module['arguments'].push("-i");
Module['arguments'].push("rootfs.cpio");
```

Initializing `Module.arguments` before utilizing it in prejs is the proper usage procedure:
```
Module['arguments'] = []
Module['arguments'].push("-k");
Module['arguments'].push("Image");
Module['arguments'].push("-b");
Module['arguments'].push("minimal.dtb");
Module['arguments'].push("-i");
Module['arguments'].push("rootfs.cpio");
```

Related to: #11239

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Öffne die verlinkte Dokumentation zur Module API und lies den Abschnitt zur Beeinflussung der Ausführung. Vergleiche anschließend dessen Beschreibung mit den prejs-Beispielen in diesem Issue. Die Aufgabe ist abgeschlossen, wenn die Dokumentation klar erklärt, dass Module.arguments initialisiert werden muss, bevor es verwendet wird, einschließlich eines geeigneten Beispiels.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
wasm
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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