Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion librarian.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1817,7 +1817,6 @@ libraries:
keep:
- CHANGELOG.md
- docs/CHANGELOG.md
skip_generate: true
python:
opt_args_by_api:
google/cloud/dialogflow/cx/v3:
Expand Down
27 changes: 14 additions & 13 deletions packages/google-cloud-dialogflow-cx/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
{
"api_id": "dialogflow.googleapis.com",
"api_shortname": "dialogflow",
"client_documentation": "https://cloud.google.com/python/docs/reference/dialogflow-cx/latest",
"default_version": "v3",
"distribution_name": "google-cloud-dialogflow-cx",
"issue_tracker": "https://issuetracker.google.com/savedsearches/5300385",
"language": "python",
"library_type": "GAPIC_AUTO",
"name": "dialogflow-cx",
"name_pretty": "Dialogflow CX",
"product_documentation": "https://cloud.google.com/dialogflow/cx/docs",
"release_level": "stable",
"repo": "googleapis/google-cloud-python"
"api_description": "Builds conversational interfaces (for example, chatbots, and voice-powered\napps and devices).",
"api_id": "dialogflow.googleapis.com",
"api_shortname": "dialogflow",
"client_documentation": "https://cloud.google.com/python/docs/reference/dialogflow-cx/latest",
"default_version": "v3",
"distribution_name": "google-cloud-dialogflow-cx",
"issue_tracker": "https://issuetracker.google.com/savedsearches/5300385",
"language": "python",
"library_type": "GAPIC_AUTO",
"name": "dialogflow-cx",
"name_pretty": "Dialogflow CX",
"product_documentation": "https://cloud.google.com/dialogflow/cx/docs",
"release_level": "stable",
"repo": "googleapis/google-cloud-python"
}
3 changes: 2 additions & 1 deletion packages/google-cloud-dialogflow-cx/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ Python Client for Dialogflow CX

|stable| |pypi| |versions|

`Dialogflow CX`_:
`Dialogflow CX`_: Builds conversational interfaces (for example, chatbots, and voice-powered
apps and devices).
Comment on lines +6 to +7
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.

medium

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.

Suggested change
`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).


- `Client Library Documentation`_
- `Product Documentation`_
Expand Down
3 changes: 2 additions & 1 deletion packages/google-cloud-dialogflow-cx/docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ Python Client for Dialogflow CX

|stable| |pypi| |versions|

`Dialogflow CX`_:
`Dialogflow CX`_: Builds conversational interfaces (for example, chatbots, and voice-powered
apps and devices).
Comment on lines +6 to +7
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.

medium

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.

Suggested change
`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).


- `Client Library Documentation`_
- `Product Documentation`_
Expand Down
1 change: 0 additions & 1 deletion packages/google-cloud-dialogflow-cx/noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,6 @@ def docs(session):
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
session.run(
"sphinx-build",
"-W", # warnings as errors
"-T", # show full traceback on exception
Comment on lines 392 to 393
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.

medium

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.

Suggested change
"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
  1. Changes to shared configurations should be applied consistently across all relevant packages in a dedicated, universal change rather than piecemeal in individual pull requests.

"-N", # no colors
"-b",
Expand Down
Loading