googleapis / gapic-generator-python

Generate Python API client libraries from Protocol Buffers.
Apache License 2.0
116 stars 66 forks source link

docs build failed in `google-apps-chat` #1969

Open parthea opened 4 months ago

parthea commented 4 months ago

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 commented 1 month ago

Wait for cl/633534188