emscripten-core/emscripten

Bug in page:html5.h

Open

#18817 opened on Feb 22, 2023

View on GitHub
 (6 comments) (0 reactions) (1 assignee)C++ (27,361 stars) (3,519 forks)batch import
docsgood first bughelp wanted

Description

https://emscripten.org/docs/api_reference/html5.h.html#c.EmscriptenGamepadEvent.id

Maximum size 64 char (i.e. EM_UTF8 id[128]).

The id[128] should be id[64] instead?

URL: ../../docs/api_reference/html5.h

Contributor guide

Tech stack
ccpp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
The issue points out a discrepancy in the documentation for EmscriptenGamepadEvent.id. The developer should locate the file `docs/api reference/html5.h` (or the corresponding source) and change the array size from `id[128]` to `id[64]` in the documentation comment. The fix is straightforward and can be done by editing the documentation source. No code changes needed.