🎨 Palette: Improve JSDoc for version comparison methods #819
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.
Improved Developer Experience (DX) by clarifying the behavior of version comparison methods in the JSDoc. Specifically, documented that
is()performs strict string comparison (novstripping) and that other methods returnfalsefor invalid inputs, addressing potential confusion for consumers.PR created automatically by Jules for task 1206760521403404357 started by @srod
Summary by cubic
Clarifies JSDoc for Node version comparison methods to prevent confusion. Documents that is() does strict string equality (no 'v' prefix handling) and that isAtLeast/isAbove/isBelow/isAtMost return false for invalid version strings; includes a changeset for a patch release.
Written for commit 92b3b39. Summary will update on new commits.