Skip to content

Commit 5e51503

Browse files
88448844AakashSuresh2003
authored andcommitted
fix(docs): fix grammar and remove duplicate words in documentation and source
Merge google#4335 Fixed 'the the' typos and grammatical errors in README, docstrings, and sample agents. **Please ensure you have read the [contribution guide](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) before creating a pull request.** ### Link to Issue or Description of Change **1. Link to an existing issue (if applicable):** - Closes: N/A - Related: N/A **2. Or, if no issue exists, describe the change:** **Problem:** While exploring the repository, I noticed a few minor writing errors that impact professional readability: 1. **Grammar:** A subject-verb agreement error in `README.md` and `llms.txt` ("guide the agents works together"). 2. **Duplicate Words:** Several instances of stuttering typos (repeating "the the" or "but the the") in docstrings within `src/` and the `contributing/samples/` directories. **Solution:** I have applied the following fixes to improve documentation quality: * Corrected phrasing to "guide the agents to work together" in the README. * Removed redundant instances of "the" in `eval_metrics.py`, `spanner/settings.py`, and the sample agent docstrings. * **No functional code or logic was altered.** ### Testing Plan **Unit Tests:** - [x] All unit tests pass locally. _Summary:_ Since this PR is strictly limited to documentation, comments, and docstrings, no new tests were required. I ran the standard test suite to ensure no syntax errors were accidentally introduced, and everything passed successfully. **Manual End-to-End (E2E) Tests:** N/A — This is a static documentation fix. ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [ ] I have commented my code, particularly in hard-to-understand areas. (N/A) - [ ] I have added tests that prove my fix is effective or that my feature works. (N/A - Doc fix only) - [x] New and existing unit tests pass locally with my changes. - [ ] I have manually tested my changes end-to-end. (N/A) - [x] Any dependent changes have been merged and published in downstream modules. ### Additional context _None._ COPYBARA_INTEGRATE_REVIEW=google#4335 from 88448844:fix-typos-and-docs 200668d PiperOrigin-RevId: 865530036
1 parent f883321 commit 5e51503

8 files changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ root_agent = Agent(
115115

116116
### Define a multi-agent system:
117117

118-
Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents works together to accomplish the task.
118+
Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents to work together to accomplish the task.
119119

120120
```python
121121
from google.adk.agents import LlmAgent, BaseAgent

contributing/samples/adk_issue_formatting_agent/agent.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def add_comment_to_issue(issue_number: int, comment: str) -> dict[str, any]:
9696
comment: comment to add
9797
9898
Returns:
99-
The the status of this request, with the applied comment when successful.
99+
The status of this request, with the applied comment when successful.
100100
"""
101101
print(f"Attempting to add comment '{comment}' to issue #{issue_number}")
102102
url = f"{GITHUB_BASE_URL}/repos/{OWNER}/{REPO}/issues/{issue_number}/comments"
@@ -119,7 +119,7 @@ def list_comments_on_issue(issue_number: int) -> dict[str, any]:
119119
issue_number: issue number of the GitHub issue
120120
121121
Returns:
122-
The the status of this request, with the list of comments when successful.
122+
The status of this request, with the list of comments when successful.
123123
"""
124124
print(f"Attempting to list comments on issue #{issue_number}")
125125
url = f"{GITHUB_BASE_URL}/repos/{OWNER}/{REPO}/issues/{issue_number}/comments"

contributing/samples/adk_pr_triaging_agent/agent.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ def add_label_to_pr(pr_number: int, label: str) -> dict[str, Any]:
166166
label: the label to add
167167
168168
Returns:
169-
The the status of this request, with the applied label and response when
169+
The status of this request, with the applied label and response when
170170
successful.
171171
"""
172172
print(f"Attempting to add label '{label}' to PR #{pr_number}")
@@ -201,7 +201,7 @@ def add_comment_to_pr(pr_number: int, comment: str) -> dict[str, Any]:
201201
comment: the comment to add
202202
203203
Returns:
204-
The the status of this request, with the applied comment when successful.
204+
The status of this request, with the applied comment when successful.
205205
"""
206206
print(f"Attempting to add comment '{comment}' to issue #{pr_number}")
207207

contributing/samples/adk_triaging_agent/agent.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ def change_issue_type(issue_number: int, issue_type: str) -> dict[str, Any]:
230230
issue_type: issue type to assign
231231
232232
Returns:
233-
The the status of this request, with the applied issue type when successful.
233+
The status of this request, with the applied issue type when successful.
234234
"""
235235
print(
236236
f"Attempting to change issue type '{issue_type}' to issue #{issue_number}"

llms-full.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ root_agent = Agent(
101101

102102
### Define a multi-agent system:
103103

104-
Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents works together to accomplish the task.
104+
Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents to work together to accomplish the task.
105105

106106
```python
107107
from google.adk.agents import LlmAgent, BaseAgent

llms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ root_agent = Agent(
103103
Define a multi-agent system:
104104

105105

106-
Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents works together to accomplish the task.
106+
Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents to work together to accomplish the task.
107107

108108

109109
from google.adk.agents import LlmAgent, BaseAgent

src/google/adk/evaluation/eval_metrics.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ class MatchType(Enum):
189189
Actual tool calls: [T1, T1.1, T2, T2.1, T2.2, T3, T3.1]
190190
191191
While the tool calls T1, T2 and T3 happened in the "Actual" and in
192-
the same order as "Expected", but the the tool calls T4 is missing.
192+
the same order as "Expected", but the tool calls T4 is missing.
193193
"""
194194

195195
ANY_ORDER = 2
@@ -215,7 +215,7 @@ class MatchType(Enum):
215215
Actual tool calls: [T1, T1.1, T2, T2.1, T2.2, T3, T3.1]
216216
217217
While the tool calls T1, T2 and T3 happened in the "Actual" and in
218-
the same order as "Expected", but the the tool calls T4 is missing.
218+
the same order as "Expected", but the tool calls T4 is missing.
219219
"""
220220

221221
match_type: MatchType = Field(

src/google/adk/tools/spanner/settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ class SpannerVectorStoreSettings(BaseModel):
150150
"""Required. The name of the embedding column to search in the vector store table."""
151151

152152
vector_length: int
153-
"""Required. The the dimension of the vectors in the `embedding_column`."""
153+
"""Required. The dimension of the vectors in the `embedding_column`."""
154154

155155
vertex_ai_embedding_model_name: str
156156
"""Required. The Vertex AI embedding model name, which is used to generate embeddings for vector store and vector similarity search.

0 commit comments

Comments
 (0)