docs: add comprehensive JSDoc documentation to utility functions and error classes - #1838
Open
Dark-Brain07 wants to merge 2 commits into
Open
docs: add comprehensive JSDoc documentation to utility functions and error classes#1838Dark-Brain07 wants to merge 2 commits into
Dark-Brain07 wants to merge 2 commits into
Conversation
…ransactions package
…s in transactions package
Dark-Brain07
force-pushed
the
improve/docs-and-tests
branch
from
February 14, 2026 05:40
190339e to
6e73b59
Compare
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.
Description
This PR adds comprehensive JSDoc documentation to exported utility functions in utils.ts and all error classes in errors.ts within the
@stacks/transactionspackage.Changes
packages/transactions/src/utils.ts
@param,@returns, and@exampletags to:packages/transactions/src/errors.ts
Motivation
These utility functions and error classes are widely used across the Stacks ecosystem but lacked inline documentation. Adding JSDoc improves:
Testing
Documentation-only changes. No functional code was modified.