-
Notifications
You must be signed in to change notification settings - Fork 454
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add introduction sections to JS API and Web API documents #1814
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it.
document/js-api/index.bs
Outdated
with their surrounding execution environment. Instead it defines an abstract [=embedding interface=] between WebAssembly and its environment, | ||
(called the *embedder*). It is only through this interface that an embedder interacts with the semantics of WebAssembly, and the embedder | ||
implements the connection between its host environment and the embedding API. | ||
This document describes the embedding of WebAssembly into JavaScript [[ECMASCRIPT]] environments, including how WebAssembly modules |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noted that ECMASCRIPT isn't actually listed in the biblio section above. Is that somehow automatic?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes: https://github.com/speced/bikeshed-data/blob/main/data/biblio/biblio-ec.data#L31 (there's probably an easier place to look than these raw files but I'm not sure where it is :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
These sections provide a bit more background about their relationship to the layer beneath them.
They also solve the problem that the existing minimal introductory text was hidden in the
bottom of the "status of this document" section.