Add JSDoc to shares helper module (closes #163)#289
Open
juanes96 wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
Heads up, the failing ci / contract check is unrelated to this change — it's a spell-check failure on README.md line 38 (unknown word "summarises"), pre-existing in main. This PR only touches sdk/src/shares.ts. Let me know if anything else is needed on my end. |
Contributor
|
|
…into add-jsdoc-shares
This file contains hidden or 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
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.
What this changes
Adds full JSDoc (@param, @returns, @throws, @example) to all exported members of the hand-written shares helper module (TOTAL_BASIS_POINTS, InvalidSharesError, validateShares, sharesFromWeights).
Why
The hand-written helpers lacked inline documentation, per #163.
Closes #163