这是indexloc提供的服务，不要输入任何密码
Skip to content

docs: Fix typos, JSON syntax, in documentation sync with the PaymentMandate class #54

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
Merged
merged 9 commits into from
Oct 13, 2025
Merged

docs: Fix typos, JSON syntax, in documentation sync with the PaymentMandate class #54

merged 9 commits into from
Oct 13, 2025
+49 −40

Conversation

@meetrick
Copy link
Contributor

@meetrick meetrick commented Sep 19, 2025

Description

Fixes minor documentation issues found during review:

  • specification.md: Fix typo "_not that" → "_note that" (maintains original intent) and add missing comma in JSON
  • README.md: Fix numbering sequence in setup instructions

All changes are documentation-only with no functional impact.

Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Fixes #<issue_number_goes_here> 🦕

@meetrick
docs: Fix typos and JSON syntax in specification.md
a5cca65 
- Fix typo: "_not that" → "_note that" in Intent Mandate section
- Add missing comma in PaymentMandate JSON example

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
@meetrick
docs: Fix numbering sequence in README setup instructions
33fff3b 
Corrects the numbering sequence in the API key setup section

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
@meetrick meetrick requested a review from a team as a code owner September 19, 2025 06:48
@google-cla
Copy link

google-cla bot commented Sep 19, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Sep 19, 2025

Summary of Changes

Hello @meetrick, 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 accuracy and consistency of the project's documentation. It addresses minor textual errors, corrects a JSON syntax issue in an example, and rectifies an incorrect numbering sequence in the setup guide. These changes are solely confined to documentation files and do not introduce any functional modifications to the application.

Highlights

  • Documentation Typos: Corrected a typo in docs/specification.md changing "_not that" to "_note that" for improved readability.
  • JSON Syntax: Added a missing comma in a JSON example within docs/specification.md to ensure valid JSON syntax.
  • Numbering Sequence: Fixed an incorrect numbering sequence in the setup instructions of README.md, changing "1." to "2." for logical flow.
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

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 Sep 19, 2025
View reviewed changes
Copy link
Contributor

@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 fixes a typo, a list numbering error, and a JSON syntax error in the documentation. The changes are approved.

However, I noticed some significant discrepancies between the JSON examples in docs/specification.md and the corresponding Python data models in src/ap2/types/. For instance, the PaymentMandate example (which this PR modifies) and the CartMandate example do not match their Python class definitions.

I've added a specific comment on the PaymentMandate example. Aligning these examples with the code would greatly improve the documentation's accuracy and usefulness for developers.

As a smaller point, you might also want to correct the numbering in the 'How to Run a Scenario' section in README.md.

@meetrick
docs: Add JWS format comment to PaymentMandate user_authorization field
b78d4bc 
- Add clarifying comment for user_authorization field in PaymentMandate examples
- Specifies that the field contains JWS compact serialization of verifiable presentation
- Improves developer understanding of the authorization format
- Applied to both specification.md and a2a-extension.md examples

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
@meetrick
Merge branch 'main' into fix/docs_readme
47fbecf
@meetrick meetrick changed the title docs: Fix typos, JSON syntax, and numbering sequence in documentation docs: Fix typos, JSON syntax, in documentation sync with the PaymentMandate class Sep 19, 2025
@kmcduffie
Copy link
Collaborator

kmcduffie commented Sep 23, 2025

Thank you! We'll get back to you shortly

joshlund-goog
joshlund-goog requested changes Oct 6, 2025
View reviewed changes
@meetrick
docs: clean up JSON samples in specification
3f8f898 
Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
joshlund-goog
joshlund-goog reviewed Oct 8, 2025
View reviewed changes
@meetrick
Deleted unnecessary comments
8568244 
Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
@meetrick
Copy link
Contributor Author

meetrick commented Oct 8, 2025

It seems like I’m getting lint code base errors even for the parts I didn’t modify.
I think it’s probably just a conflict between different lint tools, what do you think?

joshlund-goog added a commit that referenced this pull request Oct 8, 2025
@joshlund-goog
Disable Biome format
2c354c0 
It does not respect VALIDATE_ALL_CODEBASE nor FILTER_REGEX_EXCLUDE so disabling for now.

Question: #54 (comment)

Will prevent these lint errors: https://github.com/google-agentic-commerce/AP2/actions/runs/18351333407/job/52271829007?pr=54
@joshlund-goog joshlund-goog mentioned this pull request Oct 8, 2025
Merged
@joshlund-goog
Copy link
Collaborator

joshlund-goog commented Oct 8, 2025

It seems like I’m getting lint code base errors even for the parts I didn’t modify. I think it’s probably just a conflict between different lint tools, what do you think?

#87 should fix this

joshlund-goog added a commit that referenced this pull request Oct 9, 2025
@joshlund-goog
chore(lint): Disable Biome format (#87)
9caf5d8 
It does not respect VALIDATE_ALL_CODEBASE nor FILTER_REGEX_EXCLUDE so
disabling for now.

Question:
#54 (comment)

Will prevent these lint errors:
https://github.com/google-agentic-commerce/AP2/actions/runs/18351333407/job/52271829007?pr=54
@joshlund-goog
Copy link
Collaborator

joshlund-goog commented Oct 9, 2025

It seems like I’m getting lint code base errors even for the parts I didn’t modify. I think it’s probably just a conflict between different lint tools, what do you think?

#87 should fix this

Please update branch and have the lint check run again.

@meetrick
Copy link
Contributor Author

meetrick commented Oct 9, 2025

It seems like I’m getting lint code base errors even for the parts I didn’t modify. I think it’s probably just a conflict between different lint tools, what do you think?

#87 should fix this

Please update branch and have the lint check run again.

I did!

@joshlund-goog joshlund-goog merged commit b17ae16 into google-agentic-commerce:main Oct 13, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joshlund-goog joshlund-goog joshlund-goog 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

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@meetrick @kmcduffie @joshlund-goog