docs: add TSDoc for example_util, event_actions, run_config, and structured_events#381
Open
nuthalapativarun wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem / Solution
Four source files had missing or incomplete TSDoc on their exported functions and enum values. This PR adds
@param,@returns, and@throwsdocumentation aligned with the style used in the rest of the codebase and with adk-python.Files changed
core/src/examples/example_util.ts@param/@returnsforconvertExamplesToText; full@param/@returns/@throwsforbuildExampleSi; documents the gemini-2 model detection behaviorcore/src/events/event_actions.ts@param/@returnsforcreateEventActions; full merge-semantics docs formergeEventActions(dict merge vs. last-writer-wins for scalars)core/src/agents/run_config.ts@param/@returns/@throwsforcreateRunConfig; documents all defaults and themaxLlmCalls > MAX_SAFE_INTEGERthrowcore/src/events/structured_events.tsEventTypeenum members explaining what triggers each typeNo source logic was changed — this is documentation-only.
Testing Plan
npm test— 1516 tests, 125 files)npm run lint— no new errorsnpm run format— no formatting changes neededChecklist
@param name - descriptionstyle used inrunner.ts,base_agent.ts, and other documented filesadk-pythonequivalents