Skip to content

docs: fix stale JSDoc parameter names - #29231

Open
simpleqt wants to merge 1 commit into
google-gemini:mainfrom
simpleqt:docs/jsdoc-ghost-params
Open

docs: fix stale JSDoc parameter names#29231
simpleqt wants to merge 1 commit into
google-gemini:mainfrom
simpleqt:docs/jsdoc-ghost-params

Conversation

@simpleqt

@simpleqt simpleqt commented Sep 6, 2026

Copy link
Copy Markdown

Two JSDoc blocks documented parameters that no longer exist:

  1. packages/core/src/utils/workspaceContext.ts addDirectory: documented basePath, removed when path resolution moved into addDirectories
  2. packages/core/src/agents/a2a-client-manager.ts loadAgent: documented agentCardUrl; the URL now rides inside the AgentCardLoadOptions object

Docstrings only — no code change.

- workspaceContext.addDirectory documented a basePath parameter that
  was removed when path resolution moved into addDirectories
- a2a-client-manager.loadAgent documented agentCardUrl; the URL now
  rides inside the AgentCardLoadOptions object
@simpleqt
simpleqt requested a review from a team as a code owner September 6, 2026 18:37
@google-cla

google-cla Bot commented Sep 6, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@github-actions github-actions Bot added the size/xs An extra small PR label Sep 6, 2026
@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown

📊 PR Size: size/XS

  • Lines changed: 5
  • Additions: +2
  • Deletions: -3
  • Files changed: 2

@gemini-cli gemini-cli Bot added the status/need-issue Pull requests that need to have an associated issue. label Sep 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/xs An extra small PR status/need-issue Pull requests that need to have an associated issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant