gapic-generator-python
gapic-generator-python copied to clipboard
docs build failed in google-cloud-dataplex
See https://github.com/googleapis/googleapis/blob/7976ffadc0f21ee9149708c0c97ef000e15de1eb/google/cloud/dataplex/v1/catalog.proto#L1171 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: /home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/catalog.py:docstring of google.cloud.dataplex_v1.types.catalog.ListEntriesRequest:23:Inline emphasis start-string without end-string.
Instead of
// "entry_type=projects/example-project/locations/us/entryTypes/a* OR
// entry_type=projects/another-project/locations/*"
It should be
// `entry_type=projects/example-project/locations/us/entryTypes/a* OR
// entry_type=projects/another-project/locations/*`
See https://github.com/googleapis/google-cloud-python/actions/runs/9813526846/job/27099671653
We should add a check upstream for unsupported formatting in proto comments