emscripten-core/emscripten

Improve embind docs

Open

#11,878 opened on Aug 12, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (3,519 forks)batch import
embindhelp wanted

Repository metrics

Stars
 (27,361 stars)
PR merge metrics
 (Avg merge 19d 10h) (147 merged PRs in 30d)

Description

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 direction
Locate the bind.h and val.h documentation files in the repository and fill in the missing TODOs with appropriate content, referencing existing documentation and source code as needed.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75