refactor: add missing JSDoc documentation#41
Merged
melihbirim merged 2 commits intomainfrom Dec 27, 2025
Merged
Conversation
Added comprehensive JSDoc documentation for two functions that were missing it: - isRgbColor(): Documents RGB/RGBA color validation with format examples - isHashtag(): Documents hashtag validation including the preferHashtagOver3CharHex option for disambiguating from 3-char hex colors Improves code documentation and developer experience when using these functions.
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
1 participant
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 missing JSDoc documentation for two functions in
index.jsthat were previously undocumented.Changes
isRgbColor(): Added comprehensive JSDoc documenting RGB/RGBA color validation with format examplesisHashtag(): Added full JSDoc including theoptionsparameter and itspreferHashtagOver3CharHexproperty for disambiguating from 3-character hex colorsBenefits
Testing