🎨 Palette: Improved JSDoc for comparison methods #808
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.
🎨 Palette: Improved JSDoc for comparison methods
💡 What:
Updated JSDoc for
isAtLeast,isAbove,isBelow,isAtMost, andismethods insrc/types.ts.🎯 Why:
To improve Developer Experience (DX) by clarifying edge case behaviors. Users might assume
isnormalizes input likeisAtLeastdoes, or that methods throw errors on invalid input. Explicitly documenting "fail-closed" behavior prevents confusion.♿ Accessibility (DX):
is().PR created automatically by Jules for task 13051768554104792076 started by @srod
Summary by cubic
Updated JSDoc for NodeVersion comparison methods to clarify invalid input handling and strict equality. This reduces confusion around version normalization and edge cases.
isAtLeast, isAbove, isBelow, and isAtMost explicitly return false for invalid version strings. is() warns that it uses strict equality and does not normalize inputs (e.g., 'v20.0.0' != '20.0.0').
Written for commit e5ba182. Summary will update on new commits.