docs: improve JSDoc for version comparison methods #822
Conversation
- Clarify fail-closed behavior for invalid inputs in `isAtLeast`, `isAbove`, `isBelow`, `isAtMost`. - Explicitly document strict equality behavior for `is()` method. - Add link to Node.js release schedule in `EOL_DATES` documentation.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
🦋 Changeset detectedLatest commit: 1a6aa99 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #822 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 46 46
Branches 16 16
=========================================
Hits 46 46
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Superseded by #826 - closing duplicate bot-generated PR |
Understood. Acknowledging that this work is now obsolete and stopping work on this task. |
🎨 Palette: DX/UX Improvement
💡 What:
Improved JSDoc comments in
src/types.tsandsrc/index.tsto explicitly document edge case behaviors (fail-closed on invalid input) and strict equality nuances.🎯 Why:
For a library, the "User" is the Developer. Improving Developer Experience (DX) via clear, accessible documentation reduces confusion and potential bugs (e.g., expecting
is('v20.0.0')to work when it requires strict matching). This aligns with Palette's mission to improve interface accessibility—in this case, the API interface.♿ Accessibility (DX):
falsereturns for invalid strings.vprefix handling foris().Verified implementation behavior with a script to ensure documentation matches reality.
PR created automatically by Jules for task 12459724324433348593 started by @srod
Summary by cubic
Updated JSDoc for version checks to clarify that is() uses strict equality (no 'v' prefix normalization) and that all comparison methods return false on invalid version strings. Added a link to the Node.js release schedule in the EOL_DATES docs.
Written for commit 1a6aa99. Summary will update on new commits.