emscripten-core/emscripten

Improve embind docs

Offen

#11.878 geöffnet am 12.08.2020

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (3.519 Forks)batch import
embindhelp wanted

Repository-Metriken

Stars
 (27.361 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 19T 10h) (147 gemergte PRs in 30 T)

Beschreibung

A bunch of embind docs still have TODOs in them, like the main bind.h docs say they are under construction, and the val.h docs have HamishW (original docs author) TODOs and notes.

If someone has time it would be good to fill those out.

cc @chadaustin @brion @surma @RReverser

Contributor Guide

Research-Richtung
Suchen Sie die Dokumentationsdateien bind.h und val.h im Repository und füllen Sie die fehlenden TODOs mit geeigneten Inhalten, wobei Sie bei Bedarf auf vorhandene Dokumentation und Quellcode verweisen.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75