Skip to content

docs(AIP-158): clarify response plural first docs#1571

Merged
noahdietz merged 3 commits into
mainfrom
docs-158-clarification
Nov 26, 2025
Merged

docs(AIP-158): clarify response plural first docs#1571
noahdietz merged 3 commits into
mainfrom
docs-158-clarification

Conversation

@noahdietz

Copy link
Copy Markdown
Contributor

The rule has, since its inception, linted every response message containing a next_page_token field b.c that is reserved for the AIP-158 Pagination design pattern.

Closes #986 by fixing the broken docs, not changing the scope of the rule.

@noahdietz
noahdietz requested review from a team and quirogas November 25, 2025 00:22
@noahdietz
noahdietz enabled auto-merge (squash) November 25, 2025 00:23
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @noahdietz, 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 improving the accuracy of the documentation for the AIP-158 rule concerning paginated methods. It clarifies that the rule applies to any response message that includes a next_page_token field, thereby correcting the previous documentation which narrowly specified List and Search methods. The change ensures the documentation precisely reflects the existing functionality of the rule.

Highlights

  • Documentation Clarification: The documentation for the AIP-158 rule regarding paginated methods has been updated to clarify its scope.
  • Rule Application: The updated documentation now correctly states that the rule applies to all paginated response messages containing a next_page_token field, rather than being limited to List and Search methods.
  • Accuracy Improvement: This change fixes an inaccuracy in the previous documentation, ensuring it aligns with the rule's actual behavior without altering the rule itself.
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 gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 clarifies the documentation for the response-plural-first-field rule (AIP-158). The changes accurately reflect that the rule applies to any paginated response message (identified by the presence of next_page_token), not just those from List or Search methods. This improves the documentation's accuracy and clarity. I have one minor suggestion to fix a typo.

Comment thread docs/rules/0158/response-plural-first-field.md Outdated
noahdietz and others added 2 commits November 24, 2025 16:34
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@noahdietz
noahdietz merged commit 98a8702 into main Nov 26, 2025
8 checks passed
@noahdietz
noahdietz deleted the docs-158-clarification branch November 26, 2025 03:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rule catches any message with "next_page_token" field OR named [List|Search]*Response

2 participants