gapic-generator-python icon indicating copy to clipboard operation
gapic-generator-python copied to clipboard

docs build failed in `google-cloud-dms`

Open parthea opened this issue 2 years ago • 0 comments

See https://github.com/googleapis/googleapis/blob/42231337d84e862d417b6d3fd6af50ba0fcf932c/google/cloud/clouddms/v1/conversionworkspace_resources.proto#L473-L475 where there is a list which is not formatted correctly.

This caused the docs build to fail with

sphinx.errors.SphinxWarning: /usr/local/google/home/partheniou/git/google-cloud-python/packages/google-cloud-dms/google/cloud/clouddms_v1/types/conversionworkspace_resources.py:docstring of google.cloud.clouddms_v1.types.conversionworkspace_resources.MultiColumnDatatypeChange:82:Unexpected indentation.

Warning, treated as error:
/usr/local/google/home/partheniou/git/google-cloud-python/packages/google-cloud-dms/google/cloud/clouddms_v1/types/conversionworkspace_resources.py:docstring of google.cloud.clouddms_v1.types.conversionworkspace_resources.MultiColumnDatatypeChange:82:Unexpected indentation.

Instead of

  // Optional. Column fractional seconds precision - used only for timestamp
  // based datatypes - if not specified and relevant uses the source column
  // fractional seconds precision.

It should be

  // Optional. Column fractional seconds precision:
  // - used only for timestamp based datatypes
  // - if not specified and relevant uses the source column
  // fractional seconds precision.

See https://github.com/googleapis/google-cloud-python/actions/runs/7128004971/job/19409110301?pr=12079

We should add a linter rule to check for incorrect formatting of lists in proto comments via https://github.com/googleapis/api-linter .

parthea avatar Dec 07 '23 17:12 parthea