Skip to content

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

Open
darkdi wants to merge 1 commit into
nodejs:mainfrom
darkdi:docs/jsdoc-param-names
Open

docs: name the parameters these two blocks describe#5735
darkdi wants to merge 1 commit 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

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.

1 participant