docs: add JSDoc documentation to utility functions across common utils#2707
Open
Dark-Brain07 wants to merge 13 commits intostx-labs:mainfrom
Open
docs: add JSDoc documentation to utility functions across common utils#2707Dark-Brain07 wants to merge 13 commits intostx-labs:mainfrom
Dark-Brain07 wants to merge 13 commits intostx-labs:mainfrom
Conversation
|
@Dark-Brain07 is attempting to deploy a commit to the Stacks Labs Team on Vercel. A member of the Team first needs to authorize it. |
dd64b1d to
5e95867
Compare
5e95867 to
ec391c2
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.
What type of PR is this? (check all applicable)
Description
Added comprehensive JSDoc documentation with
@param,@returns, and@exampletags to several undocumented utility functions in thesrc/common/utils/directory. These functions are used throughout the explorer codebase but were missing inline documentation, making it harder for new contributors to understand their purpose and usage.Files changed:
number-utils.ts — Added JSDoc to isUint128, isStringNumber, and bigintPow with examples and context about their use in the Stacks ecosystem (e.g., uint128 for token amounts).
string-utils.ts — Added JSDoc to splitStxAddressIntoParts which was the only undocumented function in the file. Documented its grouping behavior and edge case handling for trailing characters.
validateUrl.ts — Added JSDoc to validateUrl explaining that it uses the
URLconstructor for validation, with usage examples.date-utils.ts — Added JSDoc to formatDateShort documenting the
en-GBlocale format and expected output like "14 Feb".Issue ticket number and link
N/A — proactive documentation improvement.
Checklist:
Screenshots (if appropriate):
N/A — documentation-only changes, no visual impact.