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

* 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 * fix docs build. Fix proposed upstream via cl/519090963 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
googleapis · Mar 24, 2023 · 58839c4 · 58839c4
1 parent c288fac
commit 58839c4
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 32 deletions.
diff --git a/google/cloud/tpu_v1/services/tpu/async_client.py b/google/cloud/tpu_v1/services/tpu/async_client.py
@@ -370,8 +370,7 @@ async def sample_get_node():
 
         Args:
             request (Optional[Union[google.cloud.tpu_v1.types.GetNodeRequest, dict]]):
-                The request object. Request for
-                [GetNode][google.cloud.tpu.v1.Tpu.GetNode].
+                The request object. Request for [GetNode][google.cloud.tpu.v1.Tpu.GetNode].
             name (:class:`str`):
                 Required. The resource name.
                 This corresponds to the ``name`` field
@@ -1014,7 +1013,7 @@ async def sample_list_tensor_flow_versions():
         Returns:
             google.cloud.tpu_v1.services.tpu.pagers.ListTensorFlowVersionsAsyncPager:
                 Response for
-                [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions].
+                   [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions].
 
                 Iterating over this object will yield results and
                 resolve additional pages automatically.
@@ -1227,7 +1226,7 @@ async def sample_list_accelerator_types():
         Returns:
             google.cloud.tpu_v1.services.tpu.pagers.ListAcceleratorTypesAsyncPager:
                 Response for
-                [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes].
+                   [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes].
 
                 Iterating over this object will yield results and
                 resolve additional pages automatically.

diff --git a/google/cloud/tpu_v1/services/tpu/client.py b/google/cloud/tpu_v1/services/tpu/client.py
@@ -643,8 +643,7 @@ def sample_get_node():
 
         Args:
             request (Union[google.cloud.tpu_v1.types.GetNodeRequest, dict]):
-                The request object. Request for
-                [GetNode][google.cloud.tpu.v1.Tpu.GetNode].
+                The request object. Request for [GetNode][google.cloud.tpu.v1.Tpu.GetNode].
             name (str):
                 Required. The resource name.
                 This corresponds to the ``name`` field
@@ -1290,7 +1289,7 @@ def sample_list_tensor_flow_versions():
         Returns:
             google.cloud.tpu_v1.services.tpu.pagers.ListTensorFlowVersionsPager:
                 Response for
-                [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions].
+                   [ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions].
 
                 Iterating over this object will yield results and
                 resolve additional pages automatically.
@@ -1505,7 +1504,7 @@ def sample_list_accelerator_types():
         Returns:
             google.cloud.tpu_v1.services.tpu.pagers.ListAcceleratorTypesPager:
                 Response for
-                [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes].
+                   [ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes].
 
                 Iterating over this object will yield results and
                 resolve additional pages automatically.

diff --git a/google/cloud/tpu_v2/services/tpu/async_client.py b/google/cloud/tpu_v2/services/tpu/async_client.py
@@ -370,8 +370,7 @@ async def sample_get_node():
 
         Args:
             request (Optional[Union[google.cloud.tpu_v2.types.GetNodeRequest, dict]]):
-                The request object. Request for
-                [GetNode][google.cloud.tpu.v2.Tpu.GetNode].
+                The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode].
             name (:class:`str`):
                 Required. The resource name.
                 This corresponds to the ``name`` field
@@ -1058,7 +1057,7 @@ async def sample_generate_service_identity():
         Returns:
             google.cloud.tpu_v2.types.GenerateServiceIdentityResponse:
                 Response for
-                [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
+                   [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
 
         """
         # Create or coerce a protobuf request object.
@@ -1145,7 +1144,7 @@ async def sample_list_accelerator_types():
         Returns:
             google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesAsyncPager:
                 Response for
-                [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
+                   [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
 
                 Iterating over this object will yield results and
                 resolve additional pages automatically.
@@ -1358,7 +1357,7 @@ async def sample_list_runtime_versions():
         Returns:
             google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsAsyncPager:
                 Response for
-                [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
+                   [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
 
                 Iterating over this object will yield results and
                 resolve additional pages automatically.
@@ -1564,7 +1563,7 @@ async def sample_get_guest_attributes():
         Returns:
             google.cloud.tpu_v2.types.GetGuestAttributesResponse:
                 Response for
-                [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
+                   [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
 
         """
         # Create or coerce a protobuf request object.

diff --git a/google/cloud/tpu_v2/services/tpu/client.py b/google/cloud/tpu_v2/services/tpu/client.py
@@ -647,8 +647,7 @@ def sample_get_node():
 
         Args:
             request (Union[google.cloud.tpu_v2.types.GetNodeRequest, dict]):
-                The request object. Request for
-                [GetNode][google.cloud.tpu.v2.Tpu.GetNode].
+                The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode].
             name (str):
                 Required. The resource name.
                 This corresponds to the ``name`` field
@@ -1337,7 +1336,7 @@ def sample_generate_service_identity():
         Returns:
             google.cloud.tpu_v2.types.GenerateServiceIdentityResponse:
                 Response for
-                [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
+                   [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
 
         """
         # Create or coerce a protobuf request object.
@@ -1427,7 +1426,7 @@ def sample_list_accelerator_types():
         Returns:
             google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesPager:
                 Response for
-                [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
+                   [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
 
                 Iterating over this object will yield results and
                 resolve additional pages automatically.
@@ -1640,7 +1639,7 @@ def sample_list_runtime_versions():
         Returns:
             google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsPager:
                 Response for
-                [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
+                   [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
 
                 Iterating over this object will yield results and
                 resolve additional pages automatically.
@@ -1846,7 +1845,7 @@ def sample_get_guest_attributes():
         Returns:
             google.cloud.tpu_v2.types.GetGuestAttributesResponse:
                 Response for
-                [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
+                   [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
 
         """
         # Create or coerce a protobuf request object.

diff --git a/google/cloud/tpu_v2/services/tpu/transports/rest.py b/google/cloud/tpu_v2/services/tpu/transports/rest.py
@@ -779,7 +779,6 @@ def __call__(
                 request (~.cloud_tpu.CreateNodeRequest):
                     The request object. Request for
                 [CreateNode][google.cloud.tpu.v2.Tpu.CreateNode].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -877,7 +876,6 @@ def __call__(
                 request (~.cloud_tpu.DeleteNodeRequest):
                     The request object. Request for
                 [DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -966,7 +964,6 @@ def __call__(
                 request (~.cloud_tpu.GenerateServiceIdentityRequest):
                     The request object. Request for
                 [GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1067,7 +1064,6 @@ def __call__(
                 request (~.cloud_tpu.GetAcceleratorTypeRequest):
                     The request object. Request for
                 [GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1159,7 +1155,6 @@ def __call__(
                 request (~.cloud_tpu.GetGuestAttributesRequest):
                     The request object. Request for
                 [GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1346,7 +1341,6 @@ def __call__(
                 request (~.cloud_tpu.GetRuntimeVersionRequest):
                     The request object. Request for
                 [GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1438,7 +1432,6 @@ def __call__(
                 request (~.cloud_tpu.ListAcceleratorTypesRequest):
                     The request object. Request for
                 [ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1530,7 +1523,6 @@ def __call__(
                 request (~.cloud_tpu.ListNodesRequest):
                     The request object. Request for
                 [ListNodes][google.cloud.tpu.v2.Tpu.ListNodes].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1620,7 +1612,6 @@ def __call__(
                 request (~.cloud_tpu.ListRuntimeVersionsRequest):
                     The request object. Request for
                 [ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1712,7 +1703,6 @@ def __call__(
                 request (~.cloud_tpu.StartNodeRequest):
                     The request object. Request for
                 [StartNode][google.cloud.tpu.v2.Tpu.StartNode].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1810,7 +1800,6 @@ def __call__(
                 request (~.cloud_tpu.StopNodeRequest):
                     The request object. Request for
                 [StopNode][google.cloud.tpu.v2.Tpu.StopNode].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.
@@ -1910,7 +1899,6 @@ def __call__(
                 request (~.cloud_tpu.UpdateNodeRequest):
                     The request object. Request for
                 [UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode].
-
                 retry (google.api_core.retry.Retry): Designation of what errors, if any,
                     should be retried.
                 timeout (float): The timeout for this request.