Skip to content

Add JSDoc to shares helper module (closes #163)#289

Open
juanes96 wants to merge 2 commits into
tributary-protocol:mainfrom
juanes96:add-jsdoc-shares
Open

Add JSDoc to shares helper module (closes #163)#289
juanes96 wants to merge 2 commits into
tributary-protocol:mainfrom
juanes96:add-jsdoc-shares

Conversation

@juanes96

Copy link
Copy Markdown
Contributor

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

@juanes96
juanes96 requested a review from Spagero763 as a code owner July 18, 2026 03:18
@juanes96

Copy link
Copy Markdown
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.

@Spagero763

Copy link
Copy Markdown
Contributor

contract fails on the docs spell-check: Unknown word (summarises) in README.md. That word's actually already allow-listed on main — your branch just predates it. Updating your branch to current main should clear this.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add JSDoc to the SDK helper module

3 participants