-
Notifications
You must be signed in to change notification settings - Fork 2.2k
docs(spec): Standardize spelling to 'cancelled' and 'cancellable' throughout… #1283
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.
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
base: main
Are you sure you want to change the base?
docs(spec): Standardize spelling to 'cancelled' and 'cancellable' throughout… #1283
Conversation
… documentation Fixes inconsistent spelling of cancel-related terms across the specification and documentation. The proto definition uses TASK_STATE_CANCELLED (double 'l'), but various documentation files were using single 'l' spelling. Changes: - canceled → cancelled (11 instances across 3 files) - cancelable → cancellable (4 instances across 2 files) - TaskNotCancelableError → TaskNotCancellableError (4 instances across 2 files) - URL: task-not-cancelable → task-not-cancellable (1 instance) Files modified: - docs/specification.md - docs/llms.txt - docs/topics/life-of-a-task.md All documentation now consistently uses British English spelling (double 'l') to match the proto definition and JSON naming conventions. Fixes a2aproject#1270
Summary of ChangesHello @madankumarpichamuthu, 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 addresses a spelling inconsistency within the project's documentation and specification. It standardizes the use of 'cancelled' (with double 'l') and 'cancellable' throughout various files, ensuring alignment with the existing Highlights
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.
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 effectively standardizes the spelling of 'cancelled' and 'cancellable' across the documentation, which improves consistency and aligns with the proto definitions. The changes are well-contained and address the issue described. I've found one minor typo in the process, which I've commented on.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
I think we should consolidate on the American spelling (and update the spec itself) In 0.3.0, only one of these British spellings (Cancelled) is used in the grpc spec A2A/specification/grpc/a2a.proto Line 169 in 8d57eba
Every other usage, including in JSON-RPC uses the American spelling. A2A/specification/json/a2a.json Line 2447 in 8d57eba
We'll have to have at least one breaking change, but I think it's best to consolidate into the American spelling to have as few as possible. (Canceled, cancelable) What do you think @darrelmiller ? |
Fixes markdown linting errors (MD060) introduced by longer spelling variant. The change from 'TaskNotCancelableError' to 'TaskNotCancellableError' added characters to both the error name and description text. Changes: - Line 570: Added 1 space after error name, removed space before '(e.g.,' - Line 1162: Added 1 space after error name and at end of URL column This ensures all table pipes remain vertically aligned with the header row, satisfying markdownlint's MD060 table alignment requirements. Related to a2aproject#1270 Author: Madan Kumar Pichamuthu
1d725f3 to
88235d1
Compare
Fixes inconsistent spelling of cancel-related terms across the specification and documentation. The proto definition uses TASK_STATE_CANCELLED (double 'l'), but various documentation files were using single 'l' spelling.
Changes:
Files modified:
All documentation now consistently uses double 'l' to match the proto definition and JSON naming conventions.
Fixes #1270