Skip to content

Conversation

@parthea
Copy link
Contributor

@parthea parthea commented Dec 12, 2025

Fixes #14946 by temporarily removing the -W flag to stop treating documentation warnings as errors for google-shopping-merchant-accounts. The long term solution which is to improve the documentation for google/protobuf/empty is tracked in googleapis/gapic-generator-python#2490

@parthea parthea requested review from a team as code owners December 12, 2025 19:21
@gemini-code-assist
Copy link

Summary of Changes

Hello @parthea, 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 implements an automated fix to resolve documentation build failures for the google-shopping-merchant-accounts client library. It introduces a post-processing rule to temporarily prevent documentation warnings from being treated as errors, specifically targeting an external formatting issue in google/protobuf/empty.proto. This ensures that the documentation can be generated successfully without being blocked by warnings from an external dependency.

Highlights

  • Documentation Build Fix: The pull request introduces a change to allow documentation builds for the google-shopping-merchant-accounts client library to pass, specifically by disabling the treatment of warnings as errors during the sphinx-build process.
  • Root Cause Addressed: This modification addresses a known formatting issue originating from google/protobuf/empty.proto which was causing documentation warnings and subsequently failing builds when warnings were treated as errors.
  • Automated Generation: The changes, including the addition of a post-processing configuration and the update to the noxfile.py, were automatically generated by the librarian tool.
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.

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 automated pull request disables the 'warnings as errors' setting for the documentation build of the google-shopping-merchant-accounts package. This change is a necessary workaround for a build failure caused by an upstream issue. While the change is acceptable to unblock the build, I have added a comment suggesting a more targeted, long-term solution to avoid suppressing all future documentation warnings.

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
session.run(
"sphinx-build",
"-W", # warnings as errors

Choose a reason for hiding this comment

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

medium

While removing the -W flag resolves the immediate build failure caused by the upstream issue, it has the side effect of allowing all future documentation warnings to pass silently. This could mask new issues and lead to a decline in documentation quality over time.

A more targeted approach would be to suppress only the specific "Unexpected indentation" warning. This can typically be achieved in the Sphinx conf.py file using the suppress_warnings configuration.

If modifying conf.py is not feasible within the current generator setup, this change is an acceptable workaround. However, it would be beneficial to create a follow-up issue to track implementing a more targeted suppression or to remove this workaround once the upstream issue is resolved.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is only a temporary workaround until googleapis/gapic-generator-python#2490 can be addressed.

…arnings-for-google-shopping-merchant-accounts.yaml
@parthea parthea merged commit 17e48a8 into main Dec 12, 2025
25 checks passed
@parthea parthea deleted the librarian-20251212T192037Z branch December 12, 2025 19:40
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.

CI failed in generation PR

2 participants