Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs for WASM bindings #18

Open
fjarri opened this issue Nov 29, 2020 · 0 comments
Open

Docs for WASM bindings #18

fjarri opened this issue Nov 29, 2020 · 0 comments
Labels
CI Continuous integration documentation Improvements or additions to documentation WASM Related to WASM bindings

Comments

@fjarri
Copy link
Contributor

fjarri commented Nov 29, 2020

At the moment all we have is an example from README. wasm-pack creates proper doc comments, describing the argument types and copying function docstrings from Rust sources. They are placed in pkg/umbral_pre_wasm_bg.js. A documentation generator could be run on this producing proper docs. Ideally, if it happens automatically and the docs are deployed somewhere online. Where do JS people keep their docs?
@fjarri fjarri added documentation Improvements or additions to documentation WASM Related to WASM bindings CI Continuous integration labels Nov 29, 2020
@fjarri fjarri mentioned this issue Nov 29, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CI Continuous integration documentation Improvements or additions to documentation WASM Related to WASM bindings
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fjarri