docs: complete JSDoc coverage for Stellar public API#27
Closed
JohnOluB wants to merge 1 commit into
Closed
Conversation
|
@JohnOluB Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
Closing as duplicate. Issue #10 was addressed in #14 which landed first. Sorry for the duplicated effort — that's on us for assignment-tracking visibility. Would love to keep your engagement though. A couple of nearby open Stellar Wave issues that fit a JSDoc/docs-quality contributor well:
Pick anything that fits and ping me on the issue, I'll prioritize the review. Thanks @JohnOluB. |
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.
Closes #10
Adds full JSDoc to every public export from sdk/src/chains/stellar/. Every function has a 1–2 sentence summary, @param, @returns, @throws where applicable, a copy-pasteable @example block, and @see links to related functions. Types and interfaces have per-field documentation on all non-obvious fields. Constants carry semantic meaning beyond their literal values (e.g. the migration warning on STEALTH_SIGNING_MESSAGE).
Also sets up TypeDoc (typedoc.json + dev dependency) so npx typedoc generates clean reference HTML without errors — verifiable in the docs/stellar/ directory.
Checklist:
All public exports from sdk/src/chains/stellar have JSDoc matching the quality bar
npx typedoc generates clean reference HTML without errors
No TODO or FIXME in any new JSDoc
134/134 tests passing, build clean