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-cloud-edgecontainer #1995

Open
parthea opened this issue Mar 22, 2024 · 0 comments
Open

docs build failed in google-cloud-edgecontainer #1995

parthea opened this issue Mar 22, 2024 · 0 comments
Labels
type: cleanup An internal cleanup or hygiene concern.

Comments

@parthea
Copy link
Contributor

parthea commented Mar 22, 2024

See https://github.com/googleapis/googleapis/blob/5ce591f2593cf3a2c5c370c0a0d761c2d889c6b1/google/cloud/edgecontainer/v1/resources.proto#L219-L223 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-edgecontainer/google/cloud/edgecontainer_v1/types/resources.py:docstring of google.cloud.edgecontainer_v1.types.resources.Cluster.MaintenanceEvent:22:Inline emphasis start-string without end-string.

Instead of

    // Output only. The operation for running the maintenance event. Specified
    // in the format projects/*/locations/*/operations/*. If the maintenance
    // event is split into multiple operations (e.g. due to maintenance
    // windows), the latest one is recorded.
    string operation = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

It should be

    // Output only. The operation for running the maintenance event. Specified
    // in the format `projects/*/locations/*/operations/*`. If the maintenance
    // event is split into multiple operations (e.g. due to maintenance
    // windows), the latest one is recorded.
    string operation = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

See https://github.com/googleapis/google-cloud-python/actions/runs/8383943297/job/22960516689?pr=12482

We should add a check upstream for unsupported formatting in proto comments

@parthea parthea added the type: cleanup An internal cleanup or hygiene concern. label Mar 22, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 22, 2024
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