🎨 Palette: Improve JSDoc for comparisons and EOL dates #801
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 DX Improvement
This PR improves the Developer Experience (DX) by clarifying the behavior of version comparison methods and providing context for End-of-Life (EOL) dates.
Changes:
Clarified Fail-Closed Behavior:
isAtLeast,isAbove,isBelow,isAtMost, andisinsrc/types.tsto explicitly state that they returnfalsewhen provided with invalid version strings. This helps prevent developer confusion regarding whether these methods throw or return false on bad input.Added Contextual Links:
@seelink to the official Node.js Release Schedule in the JSDoc forEOL_DATESinsrc/index.ts. This allows developers to easily verify the dates or check for updates.Verification:
bun run lintpassed.bun run testpassed (no logic changes).bun run buildpassed.Palette Journal:
.jules/palette.md.PR created automatically by Jules for task 10077741382962921148 started by @srod
Summary by cubic
Clarified JSDoc for Node version comparison methods to state they return false on invalid version strings, and added a @see link to the Node.js release schedule for EOL dates. No logic changes.
Written for commit 711cc85. Summary will update on new commits.