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-datacatalog and google-cloud-batch fail with Bullet list ends without a blank line; unexpected unindent. #1722

Open
parthea opened this issue Aug 8, 2023 · 2 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 Aug 8, 2023

See build log here which shows the docs build failure with error message Bullet list ends without a blank line; unexpected unindent.. The issue is that lines in some list items are not indented. The list exists here , but it is not indented properly in the generated output here. For example, see this error below

sphinx.errors.SphinxWarning: /usr/local/google/home/partheniou/git/google-cloud-python/packages/google-cloud-datacatalog/google/cloud/datacatalog_v1beta1/types/usage.py:docstring of google.cloud.datacatalog_v1beta1.types.usage.UsageStats:8:Bullet list ends without a blank line; unexpected unindent.

https://github.com/googleapis/googleapis-gen/blob/7e8867efbed7dbfe5ef6ec3c2c92a4bce4280f7a/google/cloud/datacatalog/v1beta1/datacatalog-v1beta1-py/google/cloud/datacatalog_v1beta1/types/usage.py#L35-L42

We have

class UsageStats(proto.Message):
    r"""Detailed counts on the entry's usage.
    Caveats:

    - Only BigQuery tables have usage stats
    - The usage stats only include BigQuery query jobs
    - The usage stats might be underestimated, e.g. wildcard table
      references are not yet counted in usage computation
    https://cloud.google.com/bigquery/docs/querying-wildcard-tables

but sphinx expects the hyperlink in the final list item to be indented

class UsageStats(proto.Message):
    r"""Detailed counts on the entry's usage.
    Caveats:

    - Only BigQuery tables have usage stats
    - The usage stats only include BigQuery query jobs
    - The usage stats might be underestimated, e.g. wildcard table
      references are not yet counted in usage computation
      https://cloud.google.com/bigquery/docs/querying-wildcard-tables
parthea added a commit to googleapis/google-cloud-python that referenced this issue Aug 8, 2023
@parthea parthea self-assigned this Aug 8, 2023
@parthea
Copy link
Contributor Author

parthea commented Aug 8, 2023

I manually fixed the docs build in googleapis/google-cloud-python@9b6b323 to unblock the owlbot PR googleapis/google-cloud-python#11539. I'll start working on a fix in the generator.

parthea added a commit to googleapis/google-cloud-python that referenced this issue Aug 8, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Aug 28, 2023
@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 11, 2023
@parthea parthea removed their assignment Sep 26, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Sep 30, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 7, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jan 9, 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 4, 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 5, 2024
@parthea parthea added type: docs Improvement to the documentation for an API. priority: p3 Desirable enhancement or fix. May not be included in next release. and removed 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 Apr 23, 2024
@parthea parthea changed the title Docs build in google-cloud-datacatalog fails with Bullet list ends without a blank line; unexpected unindent. Docs build in google-cloud-datacatalog and google-cloud-batch fail with Bullet list ends without a blank line; unexpected unindent. May 14, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 14, 2024
@parthea
Copy link
Contributor Author

parthea commented May 14, 2024

There is a similar issue in google-cloud-batch. See googleapis/google-cloud-python@c077ebe

Change

            - Batch known failures as
            https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes.
            - Batch runnable execution failures: You can
              rely on Batch logs for further diagnose:
              https://cloud.google.com/batch/docs/analyze-job-using-logs.

to

            - Batch known failures as
              https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes.
            - Batch runnable execution failures: You can
              rely on Batch logs for further diagnose:
              https://cloud.google.com/batch/docs/analyze-job-using-logs.

The formatting in the proto looks ok

https://github.com/googleapis/googleapis/blob/e3a34df5b36e38a1ee0b1544ed4ae3b99cdf0f91/google/cloud/batch/v1/task.proto#L110-L116

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