chore: remove description_override (batch 4 - to google-cloud-dlp)#16888
chore: remove description_override (batch 4 - to google-cloud-dlp)#16888parthea merged 3 commits intogoogleapis:mainfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates API descriptions across numerous Google Cloud Python client libraries by migrating descriptions from a central configuration file to individual package metadata and README files. Feedback was provided regarding the removal of the -W flag in the documentation build for the Google Analytics Data package, noting that treating warnings as errors is crucial for maintaining documentation quality in CI and that such configuration changes should be applied consistently.
| "-T", # show full traceback on exception | ||
| "-N", # no colors |
There was a problem hiding this comment.
Removing the -W flag from sphinx-build prevents warnings from being treated as errors. This can allow documentation issues like broken links or syntax errors to go unnoticed in CI. Furthermore, changes to shared configurations should be applied consistently across all relevant packages in a dedicated, universal change rather than piecemeal in individual pull requests.
| "-T", # show full traceback on exception | |
| "-N", # no colors | |
| "-W", # warnings as errors | |
| "-T", # show full traceback on exception | |
| "-N", # no colors |
References
- Changes to shared configurations, like mypy flags, should be applied consistently across all relevant packages in a dedicated, universal change rather than piecemeal in individual pull requests.
2 participants
No description provided.