Skip to content

docs(everything): rename the phantom 'options' JSDoc param to 'constraints' - #4774

Open
simpleqt wants to merge 1 commit into
modelcontextprotocol:mainfrom
simpleqt:docs/gzip-fetch-jsdoc
Open

docs(everything): rename the phantom 'options' JSDoc param to 'constraints'#4774
simpleqt wants to merge 1 commit into
modelcontextprotocol:mainfrom
simpleqt:docs/gzip-fetch-jsdoc

Conversation

@simpleqt

@simpleqt simpleqt commented Sep 7, 2026

Copy link
Copy Markdown

fetchSafely in src/everything/tools/gzip-file-as-resource.ts destructures its second parameter directly ({ maxBytes, timeoutMillis }), so the documented @param {Object} options identifier doesn't exist in the signature. The doc now names the destructured object constraints (matching what it carries) while keeping the property docs. Docs-only.

…aints'

fetchSafely destructures its second parameter directly ({ maxBytes,
timeoutMillis }) — no 'options' identifier exists; the doc now names the
destructured object consistently.
Copilot AI balanced review requested due to automatic review settings September 7, 2026 16:43

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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