Skip to content

fix: correct JSDoc#760

Open
moshams272 wants to merge 1 commit intonodejs:mainfrom
moshams272:fix-utils-jsdoc
Open

fix: correct JSDoc#760
moshams272 wants to merge 1 commit intonodejs:mainfrom
moshams272:fix-utils-jsdoc

Conversation

@moshams272
Copy link
Copy Markdown
Contributor

Description

This PR fixes minor JSDoc mismatches:

  • Reordered the JSDocs parameters of relative in file src/utils/url.mjs to match function signature.
  • Removed an unused @param (includeNonMajor) from the JSDoc of getCompatibleVersions in src/utils/generators.mjs since it doesn't exist in the function signature.

Validation

Confirmed that no functional logic was changed.

Related Issues

No Related Issues.

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run node --run test and all tests passed.
  • I have check code formatting with node --run format & node --run lint.
  • I've covered new added functionality with unit tests if necessary.

@moshams272 moshams272 requested a review from a team as a code owner April 10, 2026 13:27
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 10, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview Apr 10, 2026 1:27pm

Request Review

@cursor
Copy link
Copy Markdown

cursor bot commented Apr 10, 2026

PR Summary

Low Risk
Low risk: JSDoc-only edits that do not affect runtime logic. Main risk is limited to tooling/typedoc consumers interpreting annotations differently.

Overview
JSDoc cleanup only. Updates relative in src/utils/url.mjs to document parameters in the same order as the function signature, and removes the unused includeNonMajor parameter from getCompatibleVersions in src/utils/generators.mjs.

Reviewed by Cursor Bugbot for commit 1fda246. Bugbot is set up for automated code reviews on this repo. Configure here.

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.43%. Comparing base (4242a79) to head (1fda246).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #760      +/-   ##
==========================================
- Coverage   78.43%   78.43%   -0.01%     
==========================================
  Files         157      157              
  Lines       13963    13962       -1     
  Branches     1152     1152              
==========================================
- Hits        10952    10951       -1     
  Misses       3006     3006              
  Partials        5        5              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants