-
Notifications
You must be signed in to change notification settings - Fork 1.6k
chore: librarian generate pull request: 20251212T192037Z #14964
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
Conversation
Summary of ChangesHello @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 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 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 |
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.
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.
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.
This is only a temporary workaround until googleapis/gapic-generator-python#2490 can be addressed.
...-input/client-post-processing/allow-docs-warnings-for-google-shopping-merchant-accounts.yaml
Outdated
Show resolved
Hide resolved
…arnings-for-google-shopping-merchant-accounts.yaml
Fixes #14946 by temporarily removing the
-Wflag to stop treating documentation warnings as errors forgoogle-shopping-merchant-accounts. The long term solution which is to improve the documentation forgoogle/protobuf/emptyis tracked in googleapis/gapic-generator-python#2490