8000 Fix typos in docstrings across multiple files (#101) · arfa79/adk-python@ee2a753 · GitHub
[go: up one dir, main page]
Skip to content

Commit ee2a753

Browse files
fyhe8082fangyh20hangfei
authored
Fix typos in docstrings across multiple files (google#101)
* Fix typos in docstrings across multiple files: 'conversaction' -> 'conversation' and 'dsiabled' -> 'disabled'. Update comments for clarity. * Fix typos in comments and docstrings across multiple files - Corrected "reqeust" to "request" in auth_preprocessor.py - Fixed "credentails" to "credentials" in auth_tool.py - Updated "agetn" to "agent" in cli_eval.py - Changed "creiteria" to "criteria" in cli_tools_click.py --------- Co-authored-by: fangyu <fangyu.jobs@gmail.com> Co-authored-by: Hangfei Lin <hangfei@google.com>
1 parent b68f3aa commit ee2a753

File tree

9 files changed

+15
-15
lines changed

9 files changed

+15
-15
lines changed

‎src/google/adk/agents/base_agent.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ async def run_async(
120120
self,
121121
parent_context: InvocationContext,
122122
) -> AsyncGenerator[Event, None]:
123-
"""Entry method to run an agent via text-based conversaction.
123+
"""Entry method to run an agent via text-based conversation.
124124
125125
Args:
126126
parent_context: InvocationContext, the invocation context of the parent
@@ -152,7 +152,7 @@ async def run_live(
152152
self,
153153
parent_context: InvocationContext,
154154
) -> AsyncGenerator[Event, None]:
155-
"""Entry method to run an agent via video/audio-based conversaction.
155+
"""Entry method to run an agent via video/audio-based conversation.
156156
157157
Args:
158158
parent_context: InvocationContext, the invocation context of the parent
@@ -171,7 +171,7 @@ async def run_live(
171171
async def _run_async_impl(
172172
self, ctx: InvocationContext
173173
) -> AsyncGenerator[Event, None]:
174-
"""Core logic to run this agent via text-based conversaction.
174+
"""Core logic to run this agent via text-based conversation.
175175
176176
Args:
177177
ctx: InvocationContext, the invocation context for this agent.
@@ -187,7 +187,7 @@ async def _run_async_impl(
187187
async def _run_live_impl(
188188
self, ctx: InvocationContext
189189
) -> AsyncGenerator[Event, None]:
190-
"""Core logic to run this agent via video/audio-based conversaction.
190+
"""Core logic to run this agent via video/audio-based conversation.
191191
192192
Args:
193193
ctx: InvocationContext, the invocation context for this agent.

‎src/google/adk/agents/invocation_context.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ class InvocationContext(BaseModel):
124124
agent_2, and agent_2 is the parent of agent_3.
125125
126126
Branch is used when multiple sub-agents shouldn't see their peer agents'
127-
conversaction history.
127+
conversation history.
128128
"""
129129
agent: BaseAgent
130130
"""The current agent of this invocation context. Readonly."""

‎src/google/adk/agents/remote_agent.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class RemoteAgent(BaseAgent):
3232
sub_agents: list[BaseAgent] = Field(
3333
default_factory=list, init=False, frozen=True
3434
)
35-
"""Sub-agent is dsiabled in RemoteAgent."""
35+
"""Sub-agent is disabled in RemoteAgent."""
3636

3737
@override
3838
async def _run_async_impl(

‎src/google/adk/agents/run_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class RunConfig(BaseModel):
4242
"""Speech configuration for the live agent."""
4343

4444
response_modalities: Optional[list[str]] = None
45-
"""The output modalities. If not set, its default to AUDIO."""
45+
"""The output modalities. If not set, it's default to AUDIO."""
4646

4747
save_input_blobs_as_artifacts: bool = False
4848
"""Whether or not to save the input blobs as artifacts."""

‎src/google/adk/auth/auth_preprocessor.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ async def run_async(
7676

7777
for i in range(len(events) - 2, -1, -1):
7878
event = events[i]
79-
# looking for the system long running reqeust euc function call
79+
# looking for the system long running request euc function call
8080
function_calls = event.get_function_calls()
8181
if not function_calls:
8282
continue
@@ -92,7 +92,7 @@ async def run_async(
9292
if not tools_to_resume:
9393
continue
9494

95-
# found the the system long running reqeust euc function call
95+
# found the the system long running request euc function call
9696
# looking for original function call that requests euc
9797
for j in range(i - 1, -1, -1):
9898
event = events[j]

‎src/google/adk/auth/auth_tool.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020

2121
class AuthConfig(BaseModel):
22-
"""The auth config sent by tool asking client to collect auth credentails and
22+
"""The auth config sent by tool asking client to collect auth credentials and
2323
2424
adk and client will help to fill in the response
2525
"""

‎src/google/adk/cli/cli_eval.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ def get_evaluation_criteria_or_default(
112112

113113

114114
def get_root_agent(agent_module_file_path: str) -> Agent:
115-
"""Returns root agent given the agetn module."""
115+
"""Returns root agent given the agent module."""
116116
agent_module = _get_agent_module(agent_module_file_path)
117117
root_agent = agent_module.agent.root_agent
118118
return root_agent
119119

120120

121121
def try_get_reset_func(agent_module_file_path: str) -> Any:
122-
"""Returns reset function for the agent, if present, given the agetn module."""
122+
"""Returns reset function for the agent, if present, given the agent module."""
123123
agent_module = _get_agent_module(agent_module_file_path)
124124
reset_func = getattr(agent_module.agent, "reset_data", None)
125125
return reset_func

‎src/google/adk/cli/cli_tools_click.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ def cli_eval(
150150
EvalMetric(metric_name=metric_name, threshold=threshold)
151151
)
152152

153-
print(f"Using evaluation creiteria: {evaluation_criteria}")
153+
print(f"Using evaluation criteria: {evaluation_criteria}")
154154

155155
root_agent = get_root_agent(agent_module_file_path)
156156
reset_func = try_get_reset_func(agent_module_file_path)

‎src/google/adk/telemetry.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
#
1717
# We expect that the underlying GenAI SDK will provide a certain
1818
# level of tracing and logging telemetry aligned with Open Telemetry
19-
# Semantic Conventions (such as logging prompts, respones, request
20-
# properties, etc.) and so the information that is recorded by the
19+
# Semantic Conventions (such as logging prompts, responses,
20+
# request properties, etc.) and so the information that is recorded by the
2121
# Agent Development Kit should be focused on the higher-level
2222
# constructs of the framework that are not observable by the SDK.
2323

0 commit comments

Comments
 (0)
0