chore: enable generation of google-cloud-dialogflow-cx#16724
chore: enable generation of google-cloud-dialogflow-cx#16724jskeet merged 1 commit 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 the Dialogflow CX Python client by adding API descriptions to metadata and README files, and removing the skip_generate flag in librarian.yaml. The review identified critical issues with the reStructuredText formatting in the README files, where descriptions were incorrectly placed in hyperlink targets, which would break the links. Additionally, the removal of the -W flag in the noxfile.py was flagged as it reduces documentation quality by allowing warnings to pass during the build process.
| "sphinx-build", | ||
| "-W", # warnings as errors | ||
| "-T", # show full traceback on exception |
There was a problem hiding this comment.
The -W flag (warnings as errors) was removed from the sphinx-build command. This flag is important for maintaining documentation quality by ensuring that any syntax errors or broken references are caught during the build process. It should be restored, especially since the changes in the README files appear to introduce documentation warnings.
| "sphinx-build", | |
| "-W", # warnings as errors | |
| "-T", # show full traceback on exception | |
| "sphinx-build", | |
| "-W", # warnings as errors | |
| "-T", # show full traceback on exception |
References
- Changes to shared configurations should be applied consistently across all relevant packages in a dedicated, universal change rather than piecemeal in individual pull requests.
| `Dialogflow CX`_: Builds conversational interfaces (for example, chatbots, and voice-powered | ||
| apps and devices). |
There was a problem hiding this comment.
The hyperlink target definition for Dialogflow CX is incorrectly formatted. In reStructuredText, the syntax `Name`_: Text expects Text to be a URL. Providing a description instead will break the link and likely cause a Sphinx warning. The description should be placed on a separate line, and the link should point to the product documentation.
| `Dialogflow CX`_: Builds conversational interfaces (for example, chatbots, and voice-powered | |
| apps and devices). | |
| `Dialogflow CX`_: https://cloud.google.com/dialogflow/cx/docs | |
| Builds conversational interfaces (for example, chatbots, and voice-powered | |
| apps and devices). |
| `Dialogflow CX`_: Builds conversational interfaces (for example, chatbots, and voice-powered | ||
| apps and devices). |
There was a problem hiding this comment.
The hyperlink target definition for Dialogflow CX is incorrectly formatted. In reStructuredText, the syntax `Name`_: Text expects Text to be a URL. Providing a description instead will break the link and likely cause a Sphinx warning. The description should be placed on a separate line, and the link should point to the product documentation.
| `Dialogflow CX`_: Builds conversational interfaces (for example, chatbots, and voice-powered | |
| apps and devices). | |
| `Dialogflow CX`_: https://cloud.google.com/dialogflow/cx/docs | |
| Builds conversational interfaces (for example, chatbots, and voice-powered | |
| apps and devices). |
2 participants
No description provided.