Skip to content

chore: Fix spelling in markdown files #3403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

chore: Fix spelling in markdown files #3403

wants to merge 10 commits into from

Conversation

@jsoref
Copy link
Contributor

@jsoref jsoref commented Nov 5, 2025

This PR corrects misspellings identified by the check-spelling action

Note: while I use tooling to identify errors, the tooling doesn't actually provide the corrections, I'm picking them on my own. I'm a human, and I may make mistakes.

Testing Plan

The misspellings have been reported at https://github.com/jsoref/adk-python/actions/runs/19056081305/attempts/1#summary-54426435973

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/adk-python/actions/runs/19056081446/attempts/1#summary-54426436321

Unit Tests:

  • I have added or updated unit tests for my change.
  • All unit tests pass locally.

Please include a summary of passed pytest results.

Manual End-to-End (E2E) Tests:

Please provide instructions on how to manually test your changes, including any
necessary setup or configuration. Please provide logs or screenshots to help
reviewers better understand the fix.

Checklist

  • I have read the CONTRIBUTING.md document.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have manually tested my changes end-to-end.
  • Any dependent changes have been merged and published in downstream modules.

Additional context

jsoref added 9 commits November 5, 2025 05:44
@jsoref
link: short instruction
952ee24 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
spelling: a
68528f1 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
spelling: explicit
d3a5fd7 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
spelling: github
ce5624b 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
spelling: oauth
d3b3902 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
spelling: overridden
70b9618 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
spelling: toolset
6c93449 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
spelling: version
3505417 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
Remove duplicate changelog entry
8c0c70a 
per gemini-code-assist

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@gemini-code-assist
Copy link

gemini-code-assist bot commented Nov 5, 2025

Summary of Changes

Hello @jsoref, 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 is a maintenance chore focused on improving the quality and readability of the project's documentation. It systematically corrects various spelling mistakes and minor grammatical errors found within the CHANGELOG.md and README.md files. The primary goal is to ensure that all project-related text is accurate, professional, and consistent, thereby enhancing the overall user and developer experience when navigating the project's information.

Highlights

  • Spelling Corrections: Addressed and corrected numerous spelling errors across markdown files, enhancing documentation accuracy.
  • Grammar and Capitalization: Fixed minor grammatical inconsistencies (e.g., 'an sample' to 'a sample') and ensured proper capitalization for terms like 'OAuth2' and 'GitHub'.
  • Terminology Consistency: Standardized specific terms, such as changing 'MCPToolse' to 'MCPToolset' and 'verison' to 'version'.
  • Formatting Adjustments: Made minor formatting adjustments, like removing redundant 'here' links in some instructions.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@adk-bot adk-bot added the documentation [Component] This issue is related to documentation, it will be transferred to adk-docs label Nov 5, 2025
@gemini-code-assist
Copy link

gemini-code-assist bot commented Nov 5, 2025

Summary of Changes

Hello @jsoref, 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 refining the project's markdown documentation by fixing several spelling and grammatical errors found in CHANGELOG.md and README.md. The primary goal is to elevate the quality and professionalism of the project's user-facing content, ensuring clarity and correctness for all readers.

Highlights

  • Spelling Corrections: Corrected various spelling errors across CHANGELOG.md and README.md to enhance readability and accuracy.
  • Grammar and Capitalization: Addressed grammatical inconsistencies (e.g., 'an sample' to 'a sample') and standardized capitalization for terms like 'OAuth' and 'GitHub'.
  • Link Formatting: Improved the formatting of embedded links in the changelog and readme for better presentation.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Nov 5, 2025
View reviewed changes
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly addresses several spelling and grammatical errors in CHANGELOG.md and README.md. The changes, such as fixing typos like 'verison' to 'version' and standardizing capitalization for terms like 'OAuth' and 'GitHub', improve the overall quality and readability of the documentation. Additionally, a duplicate changelog entry was correctly removed. The changes look good and are ready to be merged.

gemini-code-assist[bot]
gemini-code-assist bot reviewed Nov 5, 2025
View reviewed changes
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request corrects several spelling and grammatical errors in the CHANGELOG.md and README.md files. The changes are accurate and improve the readability of the documentation. I have reviewed all the changes and found no issues. The PR is good to merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wuliang229 wuliang229 wuliang229 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation [Component] This issue is related to documentation, it will be transferred to adk-docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jsoref @wuliang229 @adk-bot