[Documentation] Update aleo-wasm documentation #685
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nputs in getProgramInputs and getRecord functions
iamalwaysuncomfortable
requested review from
collinc97,
onetrickwolf,
moAlobaidi and
christianwwwwwwww
There was a problem hiding this comment.
@moAlobaidi @christianwooddell This is pure documentation PR. I'd love to get your read over to get your feedback on the wording/ensure it's proper jsdoc format.
collinc97
requested review from
a team
and removed request for
collinc97,
moAlobaidi and
christianwwwwwwww
collinc97
approved these changes
Jul 28, 2023
There was a problem hiding this comment.
✅Approved. I tested doc generation locally and it works. Thanks @iamalwaysuncomfortable !
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Github actions have been created to auto-deploy documentation from the wasm crate to the Aleo Developer Hub website. All documentation in Aleo wasm should therefore be in proper JsDoc format.
This PR adds JsDoc style comments to all aleo-wasm crate methods that are part of the public api.