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-securitycentermanagement #1886

Open
parthea opened this issue Dec 6, 2023 · 0 comments
Open

docs build failed in google-cloud-securitycentermanagement #1886

parthea opened this issue Dec 6, 2023 · 0 comments
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.

Comments

@parthea
Copy link
Contributor

parthea commented Dec 6, 2023

See https://github.com/googleapis/googleapis/blob/a549ce6e7b62f6fcb808dfec151bef631c986cd5/google/cloud/securitycentermanagement/v1/security_center_management.proto#L784-L786 where there is a list which is not properly formatted

This caused the docs build to fail with

Shinx.errors.SphinxWarning: /usr/local/google/home/partheniou/git/google-cloud-python/packages/google-cloud-securitycentermanagement/google/cloud/securitycentermanagement_v1/types/security_center_management.py:docstring of google.cloud.securitycentermanagement_v1.types.security_center_management.UpdateSecurityHealthAnalyticsCustomModuleRequest:32:Unexpected indentation.

Instead of

  // invalid. Note that a subsequent request to actually update the module could
  // still fail because 1. the state could have changed (e.g. IAM permission
  // lost) or
  // 2. A failure occurred while trying to update the module.

It should be

  // invalid. Note that a subsequent request to actually update the module could
  // still fail because:
  // 1. the state could have changed (e.g. IAM permission lost) or
  // 2. A failure occurred while trying to update the module.

In addition, there is a list which has an extra leading space in front of the list items
https://github.com/googleapis/googleapis/blob/a549ce6e7b62f6fcb808dfec151bef631c986cd5/google/cloud/securitycentermanagement/v1/security_center_management.proto#L759-L761

Instead of

  // invalid. Note that a subsequent request to actually create the module could
  // still fail because:
  //  1. the state could have changed (e.g. IAM permission lost) or
  //  2. A failure occurred during creation of the module.

it should have list items without a leading space

  // invalid. Note that a subsequent request to actually create the module could
  // still fail because:
  // 1. the state could have changed (e.g. IAM permission lost) or
  // 2. A failure occurred during creation of the module.

See https://github.com/googleapis/google-cloud-python/actions/runs/7116287650/job/19374371114?pr=12089

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

@parthea parthea added type: cleanup An internal cleanup or hygiene concern. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Dec 6, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 6, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jan 13, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 1, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 3, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 14, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 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 22, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 27, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 27, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jun 10, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jul 8, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant