Skip to content
This repository was archived by the owner on Jul 6, 2023. It is now read-only.

Commit 58839c4

Browse files
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: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 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>
1 parent c288fac commit 58839c4

5 files changed

Lines changed: 16 additions & 32 deletions

File tree

google/cloud/tpu_v1/services/tpu/async_client.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -370,8 +370,7 @@ async def sample_get_node():
370370
371371
Args:
372372
request (Optional[Union[google.cloud.tpu_v1.types.GetNodeRequest, dict]]):
373-
The request object. Request for
374-
[GetNode][google.cloud.tpu.v1.Tpu.GetNode].
373+
The request object. Request for [GetNode][google.cloud.tpu.v1.Tpu.GetNode].
375374
name (:class:`str`):
376375
Required. The resource name.
377376
This corresponds to the ``name`` field
@@ -1014,7 +1013,7 @@ async def sample_list_tensor_flow_versions():
10141013
Returns:
10151014
google.cloud.tpu_v1.services.tpu.pagers.ListTensorFlowVersionsAsyncPager:
10161015
Response for
1017-
[ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions].
1016+
[ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions].
10181017
10191018
Iterating over this object will yield results and
10201019
resolve additional pages automatically.
@@ -1227,7 +1226,7 @@ async def sample_list_accelerator_types():
12271226
Returns:
12281227
google.cloud.tpu_v1.services.tpu.pagers.ListAcceleratorTypesAsyncPager:
12291228
Response for
1230-
[ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes].
1229+
[ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes].
12311230
12321231
Iterating over this object will yield results and
12331232
resolve additional pages automatically.

google/cloud/tpu_v1/services/tpu/client.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -643,8 +643,7 @@ def sample_get_node():
643643
644644
Args:
645645
request (Union[google.cloud.tpu_v1.types.GetNodeRequest, dict]):
646-
The request object. Request for
647-
[GetNode][google.cloud.tpu.v1.Tpu.GetNode].
646+
The request object. Request for [GetNode][google.cloud.tpu.v1.Tpu.GetNode].
648647
name (str):
649648
Required. The resource name.
650649
This corresponds to the ``name`` field
@@ -1290,7 +1289,7 @@ def sample_list_tensor_flow_versions():
12901289
Returns:
12911290
google.cloud.tpu_v1.services.tpu.pagers.ListTensorFlowVersionsPager:
12921291
Response for
1293-
[ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions].
1292+
[ListTensorFlowVersions][google.cloud.tpu.v1.Tpu.ListTensorFlowVersions].
12941293
12951294
Iterating over this object will yield results and
12961295
resolve additional pages automatically.
@@ -1505,7 +1504,7 @@ def sample_list_accelerator_types():
15051504
Returns:
15061505
google.cloud.tpu_v1.services.tpu.pagers.ListAcceleratorTypesPager:
15071506
Response for
1508-
[ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes].
1507+
[ListAcceleratorTypes][google.cloud.tpu.v1.Tpu.ListAcceleratorTypes].
15091508
15101509
Iterating over this object will yield results and
15111510
resolve additional pages automatically.

google/cloud/tpu_v2/services/tpu/async_client.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -370,8 +370,7 @@ async def sample_get_node():
370370
371371
Args:
372372
request (Optional[Union[google.cloud.tpu_v2.types.GetNodeRequest, dict]]):
373-
The request object. Request for
374-
[GetNode][google.cloud.tpu.v2.Tpu.GetNode].
373+
The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode].
375374
name (:class:`str`):
376375
Required. The resource name.
377376
This corresponds to the ``name`` field
@@ -1058,7 +1057,7 @@ async def sample_generate_service_identity():
10581057
Returns:
10591058
google.cloud.tpu_v2.types.GenerateServiceIdentityResponse:
10601059
Response for
1061-
[GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
1060+
[GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
10621061
10631062
"""
10641063
# Create or coerce a protobuf request object.
@@ -1145,7 +1144,7 @@ async def sample_list_accelerator_types():
11451144
Returns:
11461145
google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesAsyncPager:
11471146
Response for
1148-
[ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
1147+
[ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
11491148
11501149
Iterating over this object will yield results and
11511150
resolve additional pages automatically.
@@ -1358,7 +1357,7 @@ async def sample_list_runtime_versions():
13581357
Returns:
13591358
google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsAsyncPager:
13601359
Response for
1361-
[ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
1360+
[ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
13621361
13631362
Iterating over this object will yield results and
13641363
resolve additional pages automatically.
@@ -1564,7 +1563,7 @@ async def sample_get_guest_attributes():
15641563
Returns:
15651564
google.cloud.tpu_v2.types.GetGuestAttributesResponse:
15661565
Response for
1567-
[GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
1566+
[GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
15681567
15691568
"""
15701569
# Create or coerce a protobuf request object.

google/cloud/tpu_v2/services/tpu/client.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -647,8 +647,7 @@ def sample_get_node():
647647
648648
Args:
649649
request (Union[google.cloud.tpu_v2.types.GetNodeRequest, dict]):
650-
The request object. Request for
651-
[GetNode][google.cloud.tpu.v2.Tpu.GetNode].
650+
The request object. Request for [GetNode][google.cloud.tpu.v2.Tpu.GetNode].
652651
name (str):
653652
Required. The resource name.
654653
This corresponds to the ``name`` field
@@ -1337,7 +1336,7 @@ def sample_generate_service_identity():
13371336
Returns:
13381337
google.cloud.tpu_v2.types.GenerateServiceIdentityResponse:
13391338
Response for
1340-
[GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
1339+
[GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
13411340
13421341
"""
13431342
# Create or coerce a protobuf request object.
@@ -1427,7 +1426,7 @@ def sample_list_accelerator_types():
14271426
Returns:
14281427
google.cloud.tpu_v2.services.tpu.pagers.ListAcceleratorTypesPager:
14291428
Response for
1430-
[ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
1429+
[ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
14311430
14321431
Iterating over this object will yield results and
14331432
resolve additional pages automatically.
@@ -1640,7 +1639,7 @@ def sample_list_runtime_versions():
16401639
Returns:
16411640
google.cloud.tpu_v2.services.tpu.pagers.ListRuntimeVersionsPager:
16421641
Response for
1643-
[ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
1642+
[ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
16441643
16451644
Iterating over this object will yield results and
16461645
resolve additional pages automatically.
@@ -1846,7 +1845,7 @@ def sample_get_guest_attributes():
18461845
Returns:
18471846
google.cloud.tpu_v2.types.GetGuestAttributesResponse:
18481847
Response for
1849-
[GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
1848+
[GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
18501849
18511850
"""
18521851
# Create or coerce a protobuf request object.

google/cloud/tpu_v2/services/tpu/transports/rest.py

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,6 @@ def __call__(
779779
request (~.cloud_tpu.CreateNodeRequest):
780780
The request object. Request for
781781
[CreateNode][google.cloud.tpu.v2.Tpu.CreateNode].
782-
783782
retry (google.api_core.retry.Retry): Designation of what errors, if any,
784783
should be retried.
785784
timeout (float): The timeout for this request.
@@ -877,7 +876,6 @@ def __call__(
877876
request (~.cloud_tpu.DeleteNodeRequest):
878877
The request object. Request for
879878
[DeleteNode][google.cloud.tpu.v2.Tpu.DeleteNode].
880-
881879
retry (google.api_core.retry.Retry): Designation of what errors, if any,
882880
should be retried.
883881
timeout (float): The timeout for this request.
@@ -966,7 +964,6 @@ def __call__(
966964
request (~.cloud_tpu.GenerateServiceIdentityRequest):
967965
The request object. Request for
968966
[GenerateServiceIdentity][google.cloud.tpu.v2.Tpu.GenerateServiceIdentity].
969-
970967
retry (google.api_core.retry.Retry): Designation of what errors, if any,
971968
should be retried.
972969
timeout (float): The timeout for this request.
@@ -1067,7 +1064,6 @@ def __call__(
10671064
request (~.cloud_tpu.GetAcceleratorTypeRequest):
10681065
The request object. Request for
10691066
[GetAcceleratorType][google.cloud.tpu.v2.Tpu.GetAcceleratorType].
1070-
10711067
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10721068
should be retried.
10731069
timeout (float): The timeout for this request.
@@ -1159,7 +1155,6 @@ def __call__(
11591155
request (~.cloud_tpu.GetGuestAttributesRequest):
11601156
The request object. Request for
11611157
[GetGuestAttributes][google.cloud.tpu.v2.Tpu.GetGuestAttributes].
1162-
11631158
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11641159
should be retried.
11651160
timeout (float): The timeout for this request.
@@ -1346,7 +1341,6 @@ def __call__(
13461341
request (~.cloud_tpu.GetRuntimeVersionRequest):
13471342
The request object. Request for
13481343
[GetRuntimeVersion][google.cloud.tpu.v2.Tpu.GetRuntimeVersion].
1349-
13501344
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13511345
should be retried.
13521346
timeout (float): The timeout for this request.
@@ -1438,7 +1432,6 @@ def __call__(
14381432
request (~.cloud_tpu.ListAcceleratorTypesRequest):
14391433
The request object. Request for
14401434
[ListAcceleratorTypes][google.cloud.tpu.v2.Tpu.ListAcceleratorTypes].
1441-
14421435
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14431436
should be retried.
14441437
timeout (float): The timeout for this request.
@@ -1530,7 +1523,6 @@ def __call__(
15301523
request (~.cloud_tpu.ListNodesRequest):
15311524
The request object. Request for
15321525
[ListNodes][google.cloud.tpu.v2.Tpu.ListNodes].
1533-
15341526
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15351527
should be retried.
15361528
timeout (float): The timeout for this request.
@@ -1620,7 +1612,6 @@ def __call__(
16201612
request (~.cloud_tpu.ListRuntimeVersionsRequest):
16211613
The request object. Request for
16221614
[ListRuntimeVersions][google.cloud.tpu.v2.Tpu.ListRuntimeVersions].
1623-
16241615
retry (google.api_core.retry.Retry): Designation of what errors, if any,
16251616
should be retried.
16261617
timeout (float): The timeout for this request.
@@ -1712,7 +1703,6 @@ def __call__(
17121703
request (~.cloud_tpu.StartNodeRequest):
17131704
The request object. Request for
17141705
[StartNode][google.cloud.tpu.v2.Tpu.StartNode].
1715-
17161706
retry (google.api_core.retry.Retry): Designation of what errors, if any,
17171707
should be retried.
17181708
timeout (float): The timeout for this request.
@@ -1810,7 +1800,6 @@ def __call__(
18101800
request (~.cloud_tpu.StopNodeRequest):
18111801
The request object. Request for
18121802
[StopNode][google.cloud.tpu.v2.Tpu.StopNode].
1813-
18141803
retry (google.api_core.retry.Retry): Designation of what errors, if any,
18151804
should be retried.
18161805
timeout (float): The timeout for this request.
@@ -1910,7 +1899,6 @@ def __call__(
19101899
request (~.cloud_tpu.UpdateNodeRequest):
19111900
The request object. Request for
19121901
[UpdateNode][google.cloud.tpu.v2.Tpu.UpdateNode].
1913-
19141902
retry (google.api_core.retry.Retry): Designation of what errors, if any,
19151903
should be retried.
19161904
timeout (float): The timeout for this request.

0 commit comments

Comments
 (0)