Skip to content
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

docs build failed in google-apps-chat #1969

Open
parthea opened this issue Mar 4, 2024 · 1 comment
Open

docs build failed in google-apps-chat #1969

parthea opened this issue Mar 4, 2024 · 1 comment
Labels
type: cleanup An internal cleanup or hygiene concern.

Comments

@parthea
Copy link
Contributor

parthea commented Mar 4, 2024

See https://github.com/googleapis/googleapis/blob/2a40f63ea714c7f4c6856a5db4d1f3cc7d4c4b18/google/chat/v1/space.proto#L265 where there is an asterisk character which is not surrounded by backticks or escaped.

This caused the docs build to fail with

sphinx.errors.SphinxWarning: /usr/local/google/home/partheniou/git/google-cloud-python/packages/google-apps-chat/google/apps/chat_v1/services/chat_service/async_client.py:docstring of google.apps.chat_v1.services.chat_service.async_client.ChatServiceAsyncClient.get_space:39:Inline emphasis start-string without end-string.

Instead of

  // Required. Resource name of the space, in the form "spaces/*".
  //
  // Format: `spaces/{space}`

It should be

  // Required. Resource name of the space, in the form `spaces/*`.
  //
  // Format: `spaces/{space}`

See https://github.com/googleapis/google-cloud-python/actions/runs/8142939533/job/22253605510?pr=12379

We should add a linter rule to check for unsupported formatting in proto comments via https://github.com/googleapis/api-linter .

@parthea parthea added the type: cleanup An internal cleanup or hygiene concern. label Mar 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 27, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Apr 16, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Apr 18, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Apr 19, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 14, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 14, 2024
@parthea
Copy link
Contributor Author

parthea commented May 14, 2024

Wait for cl/633534188

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant