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] Ensure JS Doc comments in the WASM SDK are in JS Doc format #684

Closed
iamalwaysuncomfortable opened this issue Jul 27, 2023 · 1 comment
Closed

[Docs] Ensure JS Doc comments in the WASM SDK are in JS Doc format #684

iamalwaysuncomfortable opened this issue Jul 27, 2023 · 1 comment
Assignees
@iamalwaysuncomfortable
Labels
documentation Improvements or additions to documentation

Comments

@iamalwaysuncomfortable
Copy link
Collaborator

📚 Documentation

Currently the wasm documentation is being automatically pulled from the javascript wasm bindings generated from wasm-pack build and put onto the Aleo Developer hub. However, not all fields in the wasm documentation are in JsDoc format. All objects, methods, and functions in the wasm SDK should be documented in JsDoc format.
@iamalwaysuncomfortable iamalwaysuncomfortable added the documentation Improvements or additions to documentation label Jul 27, 2023
@collinc97
Copy link
Contributor

Closed by #685

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iamalwaysuncomfortable iamalwaysuncomfortable

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@collinc97 @iamalwaysuncomfortable