docs: Fix formatting of request arg in docstring (#93)

* docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: googleapis/googleapis@8a085ae Source-Link: googleapis/googleapis-gen@b2ab4b0 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Mar 23, 2023 · 2bf83b5 · 2bf83b5
1 parent 3ff6687
commit 2bf83b5
Show file tree

Hide file tree

Showing 15 changed files with 40 additions and 67 deletions.
diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/executions/async_client.py b/packages/google-cloud-run/google/cloud/run_v2/services/executions/async_client.py
@@ -373,8 +373,8 @@ async def sample_list_executions():
 
         Args:
             request (Optional[Union[google.cloud.run_v2.types.ListExecutionsRequest, dict]]):
-                The request object. Request message for retrieving a
-                list of Executions.
+                The request object. Request message for retrieving a list
+                of Executions.
             parent (:class:`str`):
                 Required. The Execution from which
                 the Executions should be listed. To list

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/executions/client.py b/packages/google-cloud-run/google/cloud/run_v2/services/executions/client.py
@@ -705,8 +705,8 @@ def sample_list_executions():
 
         Args:
             request (Union[google.cloud.run_v2.types.ListExecutionsRequest, dict]):
-                The request object. Request message for retrieving a
-                list of Executions.
+                The request object. Request message for retrieving a list
+                of Executions.
             parent (str):
                 Required. The Execution from which
                 the Executions should be listed. To list

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/executions/transports/rest.py b/packages/google-cloud-run/google/cloud/run_v2/services/executions/transports/rest.py
@@ -439,7 +439,6 @@ def __call__(
                 request (~.execution.DeleteExecutionRequest):
                     The request object. Request message for deleting an
                 Execution.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -530,7 +529,6 @@ def __call__(
                 request (~.execution.GetExecutionRequest):
                     The request object. Request message for obtaining a
                 Execution by its full name.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -623,7 +621,6 @@ def __call__(
                 request (~.execution.ListExecutionsRequest):
                     The request object. Request message for retrieving a list
                 of Executions.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/jobs/async_client.py b/packages/google-cloud-run/google/cloud/run_v2/services/jobs/async_client.py
@@ -514,8 +514,8 @@ async def sample_list_jobs():
 
         Args:
             request (Optional[Union[google.cloud.run_v2.types.ListJobsRequest, dict]]):
-                The request object. Request message for retrieving a
-                list of Jobs.
+                The request object. Request message for retrieving a list
+                of Jobs.
             parent (:class:`str`):
                 Required. The location and project to
                 list resources on. Format:
@@ -988,8 +988,7 @@ async def sample_get_iam_policy():
 
         Args:
             request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
-                The request object. Request message for `GetIamPolicy`
-                method.
+                The request object. Request message for ``GetIamPolicy`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.
@@ -1132,8 +1131,7 @@ async def sample_set_iam_policy():
 
         Args:
             request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
-                The request object. Request message for `SetIamPolicy`
-                method.
+                The request object. Request message for ``SetIamPolicy`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.
@@ -1279,8 +1277,7 @@ async def sample_test_iam_permissions():
 
         Args:
             request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
-                The request object. Request message for
-                `TestIamPermissions` method.
+                The request object. Request message for ``TestIamPermissions`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/jobs/client.py b/packages/google-cloud-run/google/cloud/run_v2/services/jobs/client.py
@@ -850,8 +850,8 @@ def sample_list_jobs():
 
         Args:
             request (Union[google.cloud.run_v2.types.ListJobsRequest, dict]):
-                The request object. Request message for retrieving a
-                list of Jobs.
+                The request object. Request message for retrieving a list
+                of Jobs.
             parent (str):
                 Required. The location and project to
                 list resources on. Format:
@@ -1324,8 +1324,7 @@ def sample_get_iam_policy():
 
         Args:
             request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
-                The request object. Request message for `GetIamPolicy`
-                method.
+                The request object. Request message for ``GetIamPolicy`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.
@@ -1467,8 +1466,7 @@ def sample_set_iam_policy():
 
         Args:
             request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
-                The request object. Request message for `SetIamPolicy`
-                method.
+                The request object. Request message for ``SetIamPolicy`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.
@@ -1613,8 +1611,7 @@ def sample_test_iam_permissions():
 
         Args:
             request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
-                The request object. Request message for
-                `TestIamPermissions` method.
+                The request object. Request message for ``TestIamPermissions`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/jobs/transports/rest.py b/packages/google-cloud-run/google/cloud/run_v2/services/jobs/transports/rest.py
@@ -708,7 +708,6 @@ def __call__(
                 request (~.job.DeleteJobRequest):
                     The request object. Request message to delete a Job by
                 its full name.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -958,7 +957,6 @@ def __call__(
                 request (~.job.GetJobRequest):
                     The request object. Request message for obtaining a Job
                 by its full name.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1049,7 +1047,6 @@ def __call__(
                 request (~.job.ListJobsRequest):
                     The request object. Request message for retrieving a list
                 of Jobs.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1139,7 +1136,6 @@ def __call__(
                 request (~.job.RunJobRequest):
                     The request object. Request message to create a new
                 Execution of a Job.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/revisions/async_client.py b/packages/google-cloud-run/google/cloud/run_v2/services/revisions/async_client.py
@@ -373,8 +373,8 @@ async def sample_list_revisions():
 
         Args:
             request (Optional[Union[google.cloud.run_v2.types.ListRevisionsRequest, dict]]):
-                The request object. Request message for retrieving a
-                list of Revisions.
+                The request object. Request message for retrieving a list
+                of Revisions.
             parent (:class:`str`):
                 Required. The Service from which the
                 Revisions should be listed. To list all
@@ -495,9 +495,10 @@ async def sample_delete_revision():
         Args:
             request (Optional[Union[google.cloud.run_v2.types.DeleteRevisionRequest, dict]]):
                 The request object. Request message for deleting a
-                retired Revision. Revision lifecycle is usually managed
-                by making changes to the parent Service. Only retired
-                revisions can be deleted with this API.
+                retired Revision. Revision lifecycle is
+                usually managed by making changes to the
+                parent Service. Only retired revisions
+                can be deleted with this API.
             name (:class:`str`):
                 Required. The name of the Revision to
                 delete. Format:

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/revisions/client.py b/packages/google-cloud-run/google/cloud/run_v2/services/revisions/client.py
@@ -713,8 +713,8 @@ def sample_list_revisions():
 
         Args:
             request (Union[google.cloud.run_v2.types.ListRevisionsRequest, dict]):
-                The request object. Request message for retrieving a
-                list of Revisions.
+                The request object. Request message for retrieving a list
+                of Revisions.
             parent (str):
                 Required. The Service from which the
                 Revisions should be listed. To list all
@@ -843,9 +843,10 @@ def sample_delete_revision():
         Args:
             request (Union[google.cloud.run_v2.types.DeleteRevisionRequest, dict]):
                 The request object. Request message for deleting a
-                retired Revision. Revision lifecycle is usually managed
-                by making changes to the parent Service. Only retired
-                revisions can be deleted with this API.
+                retired Revision. Revision lifecycle is
+                usually managed by making changes to the
+                parent Service. Only retired revisions
+                can be deleted with this API.
             name (str):
                 Required. The name of the Revision to
                 delete. Format:

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/revisions/transports/rest.py b/packages/google-cloud-run/google/cloud/run_v2/services/revisions/transports/rest.py
@@ -440,7 +440,6 @@ def __call__(
                 usually managed by making changes to the
                 parent Service. Only retired revisions
                 can be deleted with this API.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -529,7 +528,6 @@ def __call__(
                 request (~.revision.GetRevisionRequest):
                     The request object. Request message for obtaining a
                 Revision by its full name.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -622,7 +620,6 @@ def __call__(
                 request (~.revision.ListRevisionsRequest):
                     The request object. Request message for retrieving a list
                 of Revisions.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/services/async_client.py b/packages/google-cloud-run/google/cloud/run_v2/services/services/async_client.py
@@ -539,8 +539,8 @@ async def sample_list_services():
 
         Args:
             request (Optional[Union[google.cloud.run_v2.types.ListServicesRequest, dict]]):
-                The request object. Request message for retrieving a
-                list of Services.
+                The request object. Request message for retrieving a list
+                of Services.
             parent (:class:`str`):
                 Required. The location and project to
                 list resources on. Location must be a
@@ -915,8 +915,7 @@ async def sample_get_iam_policy():
 
         Args:
             request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
-                The request object. Request message for `GetIamPolicy`
-                method.
+                The request object. Request message for ``GetIamPolicy`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.
@@ -1059,8 +1058,7 @@ async def sample_set_iam_policy():
 
         Args:
             request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
-                The request object. Request message for `SetIamPolicy`
-                method.
+                The request object. Request message for ``SetIamPolicy`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.
@@ -1206,8 +1204,7 @@ async def sample_test_iam_permissions():
 
         Args:
             request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
-                The request object. Request message for
-                `TestIamPermissions` method.
+                The request object. Request message for ``TestIamPermissions`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/services/client.py b/packages/google-cloud-run/google/cloud/run_v2/services/services/client.py
@@ -880,8 +880,8 @@ def sample_list_services():
 
         Args:
             request (Union[google.cloud.run_v2.types.ListServicesRequest, dict]):
-                The request object. Request message for retrieving a
-                list of Services.
+                The request object. Request message for retrieving a list
+                of Services.
             parent (str):
                 Required. The location and project to
                 list resources on. Location must be a
@@ -1269,8 +1269,7 @@ def sample_get_iam_policy():
 
         Args:
             request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
-                The request object. Request message for `GetIamPolicy`
-                method.
+                The request object. Request message for ``GetIamPolicy`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.
@@ -1412,8 +1411,7 @@ def sample_set_iam_policy():
 
         Args:
             request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
-                The request object. Request message for `SetIamPolicy`
-                method.
+                The request object. Request message for ``SetIamPolicy`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.
@@ -1558,8 +1556,7 @@ def sample_test_iam_permissions():
 
         Args:
             request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
-                The request object. Request message for
-                `TestIamPermissions` method.
+                The request object. Request message for ``TestIamPermissions`` method.
             retry (google.api_core.retry.Retry): Designation of what errors, if any,
                 should be retried.
             timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/services/transports/rest.py b/packages/google-cloud-run/google/cloud/run_v2/services/services/transports/rest.py
@@ -589,7 +589,6 @@ def __call__(
                 request (~.gcr_service.CreateServiceRequest):
                     The request object. Request message for creating a
                 Service.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -687,7 +686,6 @@ def __call__(
                 request (~.service.DeleteServiceRequest):
                     The request object. Request message to delete a Service
                 by its full name.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -937,7 +935,6 @@ def __call__(
                 request (~.service.GetServiceRequest):
                     The request object. Request message for obtaining a
                 Service by its full name.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1034,7 +1031,6 @@ def __call__(
                 request (~.service.ListServicesRequest):
                     The request object. Request message for retrieving a list
                 of Services.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1391,7 +1387,6 @@ def __call__(
                 request (~.gcr_service.UpdateServiceRequest):
                     The request object. Request message for updating a
                 service.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/tasks/async_client.py b/packages/google-cloud-run/google/cloud/run_v2/services/tasks/async_client.py
@@ -364,8 +364,8 @@ async def sample_list_tasks():
 
         Args:
             request (Optional[Union[google.cloud.run_v2.types.ListTasksRequest, dict]]):
-                The request object. Request message for retrieving a
-                list of Tasks.
+                The request object. Request message for retrieving a list
+                of Tasks.
             parent (:class:`str`):
                 Required. The Execution from which
                 the Tasks should be listed. To list all

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/tasks/client.py b/packages/google-cloud-run/google/cloud/run_v2/services/tasks/client.py
@@ -724,8 +724,8 @@ def sample_list_tasks():
 
         Args:
             request (Union[google.cloud.run_v2.types.ListTasksRequest, dict]):
-                The request object. Request message for retrieving a
-                list of Tasks.
+                The request object. Request message for retrieving a list
+                of Tasks.
             parent (str):
                 Required. The Execution from which
                 the Tasks should be listed. To list all

diff --git a/packages/google-cloud-run/google/cloud/run_v2/services/tasks/transports/rest.py b/packages/google-cloud-run/google/cloud/run_v2/services/tasks/transports/rest.py
@@ -342,7 +342,6 @@ def __call__(
                 request (~.task.GetTaskRequest):
                     The request object. Request message for obtaining a Task
                 by its full name.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -432,7 +431,6 @@ def __call__(
                 request (~.task.ListTasksRequest):
                     The request object. Request message for retrieving a list
                 of Tasks.
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.