Skip to content

docs: name the parameters these two blocks describe - #5735

Merged
mcollina merged 2 commits into
nodejs:mainfrom
darkdi:docs/jsdoc-param-names
Sep 3, 2026
Merged

docs: name the parameters these two blocks describe#5735
mcollina merged 2 commits into
nodejs:mainfrom
darkdi:docs/jsdoc-param-names

Conversation

@darkdi

@darkdi darkdi commented Aug 29, 2026

Copy link
Copy Markdown

This relates to...

Nothing filed, I ran into it while reading the cache store.

Rationale

MemoryCacheStore.get documents its argument as req, while the method takes key and the two neighbours in the same class, createWriteStream and delete, both document key. The webidl one is the more confusing of the two: webidl.errors.exception documents opts, opts.header and opts.message, but the parameter is called message and the body reads message.header and message.message, so the documented name collides with a field name. Its two siblings, conversionFailed and invalidArgument, name the bag opts and context and document exactly that.

Changes

Comments only, no runtime change.

Features

N/A

Bug Fixes

N/A

Breaking Changes and Deprecations

N/A

Status

@codecov-commenter

codecov-commenter commented Sep 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.50%. Comparing base (af02617) to head (b272e99).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5735      +/-   ##
==========================================
+ Coverage   93.49%   93.50%   +0.01%     
==========================================
  Files         110      110              
  Lines       39050    39050              
==========================================
+ Hits        36510    36514       +4     
+ Misses       2540     2536       -4     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@darkdi

darkdi commented Sep 2, 2026

Copy link
Copy Markdown
Author

The Node 26 jobs are red on one test out of 1519, test/http2-request-never-settles.js, which timed out at 3002ms on every platform in that run. This PR only renames two JSDoc @PARAM names, so nothing here touches http2 or timing, and the same suite is green on main.

@mcollina mcollina left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mcollina
mcollina merged commit b8be027 into nodejs:main Sep 3, 2026
36 checks passed
@github-actions github-actions Bot mentioned this pull request Sep 4, 2026
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.

4 participants