Skip to content

docs build failed in google-cloud-deploy #1887

Open
@parthea

Description

@parthea

See https://github.com/googleapis/googleapis/blob/42231337d84e862d417b6d3fd6af50ba0fcf932c/google/cloud/deploy/v1/cloud_deploy.proto#L1607-L1609 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-cloud-deploy/google/cloud/deploy_v1/types/cloud_deploy.py:docstring of google.cloud.deploy_v1.types.cloud_deploy.SkaffoldModules.SkaffoldGCSSource:5:Inline emphasis start-string without end-string.

Warning, treated as error:
/usr/local/google/home/partheniou/git/google-cloud-python/packages/google-cloud-deploy/google/cloud/deploy_v1/types/cloud_deploy.py:docstring of google.cloud.deploy_v1.types.cloud_deploy.SkaffoldModules.SkaffoldGCSSource:5:Inline emphasis start-string without end-string.

Instead of

  message SkaffoldGCSSource {
    // Required. Cloud Storage source paths to copy recursively. For example,
    // providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying

It should be

  message SkaffoldGCSSource {
    // Required. Cloud Storage source paths to copy recursively. For example,
    // providing `gs://my-bucket/dir/configs/*` will result in Skaffold copying

See https://github.com/googleapis/google-cloud-python/actions/runs/7128004971/job/19409110301?pr=12079

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p2Moderately-important priority. Fix may not be included in next release.type: cleanupAn internal cleanup or hygiene concern.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions