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

Sphinx warning in generated client for google/cloud/gkebackup/v1

Open parthea opened this issue 3 years ago • 0 comments

The generated client for google/cloud/gkebackup/v1 contains a docstring with a list which is not formatted correctly resulting in the following errors:

sphinx.errors.SphinxWarning: /usr/local/google/home/partheniou/git/python-gke-backup/google/cloud/gke_backup_v1/services/backup_for_gke/async_client.py:docstring of google.cloud.gke_backup_v1.services.backup_for_gke.async_client.BackupForGKEAsyncClient.create_backup:44:Block quote ends without a blank line; unexpected unindent.

Warning, treated as error:
/usr/local/google/home/partheniou/git/python-gke-backup/google/cloud/gke_backup_v1/services/backup_for_gke/async_client.py:docstring of google.cloud.gke_backup_v1.services.backup_for_gke.async_client.BackupForGKEAsyncClient.create_backup:44:Block quote ends without a blank line; unexpected unindent.

Source: https://github.com/googleapis/googleapis-gen/blob/master/google/cloud/gkebackup/v1/gkebackup-v1-py/google/cloud/gke_backup_v1/services/backup_for_gke/async_client.py#L873

            backup_id (:class:`str`):
                The client-provided short name for
                the Backup resource. This name must:

                 - be between 1 and 63 characters long
                (inclusive)  - consist of only
                lower-case ASCII letters, numbers, and
                dashes  - start with a lower-case letter
                 - end with a lower-case letter or
                number
                 - be unique within the set of Backups
                in this BackupPlan

Marking this as P2 as I've added a workaround in the client library to allow the docs check to pass.

parthea avatar Jun 29 '22 16:06 parthea