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

Several docs builds failing with unexpected indentation #1690

Closed
parthea opened this issue Jul 11, 2023 · 0 comments · Fixed by #1691
Closed

Several docs builds failing with unexpected indentation #1690

parthea opened this issue Jul 11, 2023 · 0 comments · Fixed by #1691
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@parthea
Copy link
Contributor

parthea commented Jul 11, 2023

See build log here which shows several docs build failures with error message unexpected indentation. The issue is that sphinx expects a new line before a list, and most protos do not have this new line. For example, see this error below

sphinx.errors.SphinxWarning: /home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-advisorynotifications/google/cloud/advisorynotifications_v1/types/service.py:docstring of google.cloud.advisorynotifications_v1.types.service.LocalizationState:10:Unexpected indentation.

https://github.com/googleapis/googleapis-gen/blob/52c83f985d3fe2c248378988aee6fda6606f9ef3/google/cloud/advisorynotifications/v1/advisorynotifications-v1-py/google/cloud/advisorynotifications_v1/types/service.py#L72

We have

            Localization is not applicable for requested
            language. This can happen when:
            - The requested language was not supported by
              Advisory Notifications at the time of
              localization (including notifications created
              before the localization feature was launched).
            - The requested language is English, so only the
              English text is returned.

but sphinx expects an additional line after the colon

            Localization is not applicable for requested
            language. This can happen when:

            - The requested language was not supported by
              Advisory Notifications at the time of
              localization (including notifications created
              before the localization feature was launched).
            - The requested language is English, so only the
              English text is returned.
@parthea parthea added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. labels Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant