fix(docs): fix grammar and remove duplicate words in documentation and source#4335
fix(docs): fix grammar and remove duplicate words in documentation and source#433588448844 wants to merge 3 commits intogoogle:mainfrom
Conversation
Fixed 'the the' typos and grammatical errors in README, docstrings, and sample agents.
Summary of ChangesHello @88448844, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the overall readability and professionalism of the project's documentation and docstrings. It addresses minor grammatical inaccuracies and removes repetitive words that were identified throughout the codebase, ensuring a cleaner and more precise textual presentation without altering any functional code or logic. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request addresses several minor grammatical errors and typos across the repository's documentation, docstrings, and sample agents. The changes, such as correcting 'the the' to 'the' and fixing subject-verb agreement, are accurate and improve the overall readability and professionalism of the content. The scope of the PR is well-defined and the fixes have been applied correctly. No functional code has been altered, as stated in the description. The changes look good.
|
Hi @88448844 , Thank you for your contribution! We appreciate you taking the time to submit this pull request. Your PR has been received by the team and is currently under review. We will provide feedback as soon as we have an update to share. |
|
Hi @wuliang229 , can you please review this. LGTM |
…d source Merge #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=#4335 from 88448844:fix-typos-and-docs 200668d PiperOrigin-RevId: 865530036
Fixed 'the the' typos and grammatical errors in README, docstrings, and sample agents.
Please ensure you have read the contribution guide before creating a pull request.
Link to Issue or Description of Change
1. Link to an existing issue (if applicable):
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:
README.mdandllms.txt("guide the agents works together").src/and thecontributing/samples/directories.Solution:
I have applied the following fixes to improve documentation quality:
eval_metrics.py,spanner/settings.py, and the sample agent docstrings.Testing Plan
Unit Tests:
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
Additional context
None.