-
Notifications
You must be signed in to change notification settings - Fork 72
Open
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.
Description
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.
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
Metadata
Metadata
Assignees
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.