Skip to content

docs(sdk): add JSDoc to exported interfaces in packages/sdk/src/types.ts #21505

@manas-raj999

Description

@manas-raj999

Summary

packages/sdk/src/types.ts exports several public interfaces that lack
JSDoc documentation, making it harder for SDK consumers and new
contributors to understand their purpose without reading the implementation.

Affected symbols

  • SystemInstructions
  • GeminiCliAgentOptions
  • AgentFilesystem
  • AgentShellOptions
  • AgentShellResult
  • AgentShell
  • SessionContext

Proposed change

Add JSDoc comments above each exported symbol describing its purpose
and usage.

Files touched

1 file only: packages/sdk/src/types.ts

Metadata

Metadata

Assignees

Labels

area/agentIssues related to Core Agent, Tools, Memory, Sub-Agents, Hooks, Agent Qualityarea/coreIssues related to User Interface, OS Support, Core Functionalityarea/documentationGemini CLI documentation tasks and issuestype/feature
No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions