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 in google-cloud-enterpriseknowledgegraph fails with Bullet list ends without a blank line; unexpected unindent. #1773

Open
parthea opened this issue Sep 18, 2023 · 0 comments
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@parthea
Copy link
Contributor

parthea commented Sep 18, 2023

I had to manually fix a google-cloud-python PR that had a comment looking like this:

        Attributes:
            enable_geocoding_separation (bool):
                If true, separate clusters by their
                geographic region (from geocoding). Uses the
                following entity features:

                - schema.org/addressLocality
                - schema.org/addressRegion
                - schema.org/addressCountry
                Warning: processing will no longer be
                regionalized!

The issue is that sphinx expects a new line after list items.

Sphinx expects this:

        Attributes:
            enable_geocoding_separation (bool):
                If true, separate clusters by their
                geographic region (from geocoding). Uses the
                following entity features:

                - schema.org/addressLocality
                - schema.org/addressRegion
                - schema.org/addressCountry
  
                Warning: processing will no longer be
                regionalized!

We should add this as a test here and also consider proposing an update to AIPs to check if the API protos could follow this convention as well.

@parthea parthea added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Sep 18, 2023
ohmayr added a commit to googleapis/google-cloud-python that referenced this issue Oct 18, 2023
parthea pushed a commit to googleapis/google-cloud-python that referenced this issue Dec 7, 2023
parthea pushed a commit to googleapis/google-cloud-python that referenced this issue Feb 1, 2024
parthea pushed a commit to googleapis/google-cloud-python that referenced this issue Feb 4, 2024
parthea pushed a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 2024
parthea pushed a commit to googleapis/google-cloud-python that referenced this issue Mar 5, 2024
@parthea parthea added priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Apr 23, 2024
parthea pushed a commit to googleapis/google-cloud-python that referenced this issue Jul 8, 2024
parthea pushed 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: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

1 participant