Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Docs build in google-cloud-datacatalog and google-cloud-batch fail with Bullet list ends without a blank line; unexpected unindent. #16396

Copy link
Copy link

Description

@parthea
Issue body actions

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
Reactions are currently unavailable

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p3Desirable enhancement or fix. May not be included in next release.Desirable enhancement or fix. May not be included in next release.type: docsImprovement to the documentation for an API.Improvement to the documentation for an API.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.