Skip to content
This repository was archived by the owner on Apr 20, 2024. It is now read-only.

Commit 1edd640

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Fix formatting of request arg in docstring (#512)
* 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 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 2e7ee2d commit 1edd640

File tree

15 files changed

+130
-176
lines changed

15 files changed

+130
-176
lines changed

‎google/cloud/speech_v1/services/adaptation/async_client.py‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,8 @@ async def sample_create_phrase_set():
259259
260260
Args:
261261
request (Optional[Union[google.cloud.speech_v1.types.CreatePhraseSetRequest, dict]]):
262-
The request object. Message sent by the client for the
263-
`CreatePhraseSet` method.
262+
The request object. Message sent by the client for the ``CreatePhraseSet``
263+
method.
264264
parent (:class:`str`):
265265
Required. The parent resource where this phrase set will
266266
be created. Format:
@@ -396,8 +396,8 @@ async def sample_get_phrase_set():
396396
397397
Args:
398398
request (Optional[Union[google.cloud.speech_v1.types.GetPhraseSetRequest, dict]]):
399-
The request object. Message sent by the client for the
400-
`GetPhraseSet` method.
399+
The request object. Message sent by the client for the ``GetPhraseSet``
400+
method.
401401
name (:class:`str`):
402402
Required. The name of the phrase set to retrieve.
403403
Format:
@@ -512,8 +512,8 @@ async def sample_list_phrase_set():
512512
513513
Args:
514514
request (Optional[Union[google.cloud.speech_v1.types.ListPhraseSetRequest, dict]]):
515-
The request object. Message sent by the client for the
516-
`ListPhraseSet` method.
515+
The request object. Message sent by the client for the ``ListPhraseSet``
516+
method.
517517
parent (:class:`str`):
518518
Required. The parent, which owns this collection of
519519
phrase set. Format:
@@ -638,8 +638,8 @@ async def sample_update_phrase_set():
638638
639639
Args:
640640
request (Optional[Union[google.cloud.speech_v1.types.UpdatePhraseSetRequest, dict]]):
641-
The request object. Message sent by the client for the
642-
`UpdatePhraseSet` method.
641+
The request object. Message sent by the client for the ``UpdatePhraseSet``
642+
method.
643643
phrase_set (:class:`google.cloud.speech_v1.types.PhraseSet`):
644644
Required. The phrase set to update.
645645
@@ -761,8 +761,8 @@ async def sample_delete_phrase_set():
761761
762762
Args:
763763
request (Optional[Union[google.cloud.speech_v1.types.DeletePhraseSetRequest, dict]]):
764-
The request object. Message sent by the client for the
765-
`DeletePhraseSet` method.
764+
The request object. Message sent by the client for the ``DeletePhraseSet``
765+
method.
766766
name (:class:`str`):
767767
Required. The name of the phrase set to delete. Format:
768768
@@ -860,8 +860,8 @@ async def sample_create_custom_class():
860860
861861
Args:
862862
request (Optional[Union[google.cloud.speech_v1.types.CreateCustomClassRequest, dict]]):
863-
The request object. Message sent by the client for the
864-
`CreateCustomClass` method.
863+
The request object. Message sent by the client for the ``CreateCustomClass``
864+
method.
865865
parent (:class:`str`):
866866
Required. The parent resource where this custom class
867867
will be created. Format:
@@ -1001,8 +1001,8 @@ async def sample_get_custom_class():
10011001
10021002
Args:
10031003
request (Optional[Union[google.cloud.speech_v1.types.GetCustomClassRequest, dict]]):
1004-
The request object. Message sent by the client for the
1005-
`GetCustomClass` method.
1004+
The request object. Message sent by the client for the ``GetCustomClass``
1005+
method.
10061006
name (:class:`str`):
10071007
Required. The name of the custom class to retrieve.
10081008
Format:
@@ -1113,8 +1113,8 @@ async def sample_list_custom_classes():
11131113
11141114
Args:
11151115
request (Optional[Union[google.cloud.speech_v1.types.ListCustomClassesRequest, dict]]):
1116-
The request object. Message sent by the client for the
1117-
`ListCustomClasses` method.
1116+
The request object. Message sent by the client for the ``ListCustomClasses``
1117+
method.
11181118
parent (:class:`str`):
11191119
Required. The parent, which owns this collection of
11201120
custom classes. Format:
@@ -1239,8 +1239,8 @@ async def sample_update_custom_class():
12391239
12401240
Args:
12411241
request (Optional[Union[google.cloud.speech_v1.types.UpdateCustomClassRequest, dict]]):
1242-
The request object. Message sent by the client for the
1243-
`UpdateCustomClass` method.
1242+
The request object. Message sent by the client for the ``UpdateCustomClass``
1243+
method.
12441244
custom_class (:class:`google.cloud.speech_v1.types.CustomClass`):
12451245
Required. The custom class to update.
12461246
@@ -1366,8 +1366,8 @@ async def sample_delete_custom_class():
13661366
13671367
Args:
13681368
request (Optional[Union[google.cloud.speech_v1.types.DeleteCustomClassRequest, dict]]):
1369-
The request object. Message sent by the client for the
1370-
`DeleteCustomClass` method.
1369+
The request object. Message sent by the client for the ``DeleteCustomClass``
1370+
method.
13711371
name (:class:`str`):
13721372
Required. The name of the custom class to delete.
13731373
Format:

‎google/cloud/speech_v1/services/adaptation/client.py‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -512,8 +512,8 @@ def sample_create_phrase_set():
512512
513513
Args:
514514
request (Union[google.cloud.speech_v1.types.CreatePhraseSetRequest, dict]):
515-
The request object. Message sent by the client for the
516-
`CreatePhraseSet` method.
515+
The request object. Message sent by the client for the ``CreatePhraseSet``
516+
method.
517517
parent (str):
518518
Required. The parent resource where this phrase set will
519519
be created. Format:
@@ -649,8 +649,8 @@ def sample_get_phrase_set():
649649
650650
Args:
651651
request (Union[google.cloud.speech_v1.types.GetPhraseSetRequest, dict]):
652-
The request object. Message sent by the client for the
653-
`GetPhraseSet` method.
652+
The request object. Message sent by the client for the ``GetPhraseSet``
653+
method.
654654
name (str):
655655
Required. The name of the phrase set to retrieve.
656656
Format:
@@ -765,8 +765,8 @@ def sample_list_phrase_set():
765765
766766
Args:
767767
request (Union[google.cloud.speech_v1.types.ListPhraseSetRequest, dict]):
768-
The request object. Message sent by the client for the
769-
`ListPhraseSet` method.
768+
The request object. Message sent by the client for the ``ListPhraseSet``
769+
method.
770770
parent (str):
771771
Required. The parent, which owns this collection of
772772
phrase set. Format:
@@ -891,8 +891,8 @@ def sample_update_phrase_set():
891891
892892
Args:
893893
request (Union[google.cloud.speech_v1.types.UpdatePhraseSetRequest, dict]):
894-
The request object. Message sent by the client for the
895-
`UpdatePhraseSet` method.
894+
The request object. Message sent by the client for the ``UpdatePhraseSet``
895+
method.
896896
phrase_set (google.cloud.speech_v1.types.PhraseSet):
897897
Required. The phrase set to update.
898898
@@ -1014,8 +1014,8 @@ def sample_delete_phrase_set():
10141014
10151015
Args:
10161016
request (Union[google.cloud.speech_v1.types.DeletePhraseSetRequest, dict]):
1017-
The request object. Message sent by the client for the
1018-
`DeletePhraseSet` method.
1017+
The request object. Message sent by the client for the ``DeletePhraseSet``
1018+
method.
10191019
name (str):
10201020
Required. The name of the phrase set to delete. Format:
10211021
@@ -1113,8 +1113,8 @@ def sample_create_custom_class():
11131113
11141114
Args:
11151115
request (Union[google.cloud.speech_v1.types.CreateCustomClassRequest, dict]):
1116-
The request object. Message sent by the client for the
1117-
`CreateCustomClass` method.
1116+
The request object. Message sent by the client for the ``CreateCustomClass``
1117+
method.
11181118
parent (str):
11191119
Required. The parent resource where this custom class
11201120
will be created. Format:
@@ -1254,8 +1254,8 @@ def sample_get_custom_class():
12541254
12551255
Args:
12561256
request (Union[google.cloud.speech_v1.types.GetCustomClassRequest, dict]):
1257-
The request object. Message sent by the client for the
1258-
`GetCustomClass` method.
1257+
The request object. Message sent by the client for the ``GetCustomClass``
1258+
method.
12591259
name (str):
12601260
Required. The name of the custom class to retrieve.
12611261
Format:
@@ -1366,8 +1366,8 @@ def sample_list_custom_classes():
13661366
13671367
Args:
13681368
request (Union[google.cloud.speech_v1.types.ListCustomClassesRequest, dict]):
1369-
The request object. Message sent by the client for the
1370-
`ListCustomClasses` method.
1369+
The request object. Message sent by the client for the ``ListCustomClasses``
1370+
method.
13711371
parent (str):
13721372
Required. The parent, which owns this collection of
13731373
custom classes. Format:
@@ -1492,8 +1492,8 @@ def sample_update_custom_class():
14921492
14931493
Args:
14941494
request (Union[google.cloud.speech_v1.types.UpdateCustomClassRequest, dict]):
1495-
The request object. Message sent by the client for the
1496-
`UpdateCustomClass` method.
1495+
The request object. Message sent by the client for the ``UpdateCustomClass``
1496+
method.
14971497
custom_class (google.cloud.speech_v1.types.CustomClass):
14981498
Required. The custom class to update.
14991499
@@ -1619,8 +1619,8 @@ def sample_delete_custom_class():
16191619
16201620
Args:
16211621
request (Union[google.cloud.speech_v1.types.DeleteCustomClassRequest, dict]):
1622-
The request object. Message sent by the client for the
1623-
`DeleteCustomClass` method.
1622+
The request object. Message sent by the client for the ``DeleteCustomClass``
1623+
method.
16241624
name (str):
16251625
Required. The name of the custom class to delete.
16261626
Format:

‎google/cloud/speech_v1/services/adaptation/transports/rest.py‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,6 @@ def __call__(
540540
request (~.cloud_speech_adaptation.CreateCustomClassRequest):
541541
The request object. Message sent by the client for the ``CreateCustomClass``
542542
method.
543-
544543
retry (google.api_core.retry.Retry): Designation of what errors, if any,
545544
should be retried.
546545
timeout (float): The timeout for this request.
@@ -646,7 +645,6 @@ def __call__(
646645
request (~.cloud_speech_adaptation.CreatePhraseSetRequest):
647646
The request object. Message sent by the client for the ``CreatePhraseSet``
648647
method.
649-
650648
retry (google.api_core.retry.Retry): Designation of what errors, if any,
651649
should be retried.
652650
timeout (float): The timeout for this request.
@@ -748,7 +746,6 @@ def __call__(
748746
request (~.cloud_speech_adaptation.DeleteCustomClassRequest):
749747
The request object. Message sent by the client for the ``DeleteCustomClass``
750748
method.
751-
752749
retry (google.api_core.retry.Retry): Designation of what errors, if any,
753750
should be retried.
754751
timeout (float): The timeout for this request.
@@ -826,7 +823,6 @@ def __call__(
826823
request (~.cloud_speech_adaptation.DeletePhraseSetRequest):
827824
The request object. Message sent by the client for the ``DeletePhraseSet``
828825
method.
829-
830826
retry (google.api_core.retry.Retry): Designation of what errors, if any,
831827
should be retried.
832828
timeout (float): The timeout for this request.
@@ -904,7 +900,6 @@ def __call__(
904900
request (~.cloud_speech_adaptation.GetCustomClassRequest):
905901
The request object. Message sent by the client for the ``GetCustomClass``
906902
method.
907-
908903
retry (google.api_core.retry.Retry): Designation of what errors, if any,
909904
should be retried.
910905
timeout (float): The timeout for this request.
@@ -1001,7 +996,6 @@ def __call__(
1001996
request (~.cloud_speech_adaptation.GetPhraseSetRequest):
1002997
The request object. Message sent by the client for the ``GetPhraseSet``
1003998
method.
1004-
1005999
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10061000
should be retried.
10071001
timeout (float): The timeout for this request.
@@ -1092,7 +1086,6 @@ def __call__(
10921086
request (~.cloud_speech_adaptation.ListCustomClassesRequest):
10931087
The request object. Message sent by the client for the ``ListCustomClasses``
10941088
method.
1095-
10961089
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10971090
should be retried.
10981091
timeout (float): The timeout for this request.
@@ -1184,7 +1177,6 @@ def __call__(
11841177
request (~.cloud_speech_adaptation.ListPhraseSetRequest):
11851178
The request object. Message sent by the client for the ``ListPhraseSet``
11861179
method.
1187-
11881180
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11891181
should be retried.
11901182
timeout (float): The timeout for this request.
@@ -1274,7 +1266,6 @@ def __call__(
12741266
request (~.cloud_speech_adaptation.UpdateCustomClassRequest):
12751267
The request object. Message sent by the client for the ``UpdateCustomClass``
12761268
method.
1277-
12781269
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12791270
should be retried.
12801271
timeout (float): The timeout for this request.
@@ -1380,7 +1371,6 @@ def __call__(
13801371
request (~.cloud_speech_adaptation.UpdatePhraseSetRequest):
13811372
The request object. Message sent by the client for the ``UpdatePhraseSet``
13821373
method.
1383-
13841374
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13851375
should be retried.
13861376
timeout (float): The timeout for this request.

‎google/cloud/speech_v1/services/speech/async_client.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -260,8 +260,8 @@ async def sample_recognize():
260260
261261
Args:
262262
request (Optional[Union[google.cloud.speech_v1.types.RecognizeRequest, dict]]):
263-
The request object. The top-level message sent by the
264-
client for the `Recognize` method.
263+
The request object. The top-level message sent by the client for the
264+
``Recognize`` method.
265265
config (:class:`google.cloud.speech_v1.types.RecognitionConfig`):
266266
Required. Provides information to the
267267
recognizer that specifies how to process
@@ -394,8 +394,8 @@ async def sample_long_running_recognize():
394394
395395
Args:
396396
request (Optional[Union[google.cloud.speech_v1.types.LongRunningRecognizeRequest, dict]]):
397-
The request object. The top-level message sent by the
398-
client for the `LongRunningRecognize` method.
397+
The request object. The top-level message sent by the client for the
398+
``LongRunningRecognize`` method.
399399
config (:class:`google.cloud.speech_v1.types.RecognitionConfig`):
400400
Required. Provides information to the
401401
recognizer that specifies how to process
@@ -531,13 +531,13 @@ def request_generator():
531531
532532
Args:
533533
requests (AsyncIterator[`google.cloud.speech_v1.types.StreamingRecognizeRequest`]):
534-
The request object AsyncIterator. The top-level message sent by the
535-
client for the `StreamingRecognize` method. Multiple
536-
`StreamingRecognizeRequest` messages are sent. The first
537-
message must contain a `streaming_config` message and
538-
must not contain `audio_content`. All subsequent
539-
messages must contain `audio_content` and must not
540-
contain a `streaming_config` message.
534+
The request object AsyncIterator. The top-level message sent by the client for the
535+
``StreamingRecognize`` method. Multiple
536+
``StreamingRecognizeRequest`` messages are sent. The
537+
first message must contain a ``streaming_config``
538+
message and must not contain ``audio_content``. All
539+
subsequent messages must contain ``audio_content`` and
540+
must not contain a ``streaming_config`` message.
541541
retry (google.api_core.retry.Retry): Designation of what errors, if any,
542542
should be retried.
543543
timeout (float): The timeout for this request.

‎google/cloud/speech_v1/services/speech/client.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -516,8 +516,8 @@ def sample_recognize():
516516
517517
Args:
518518
request (Union[google.cloud.speech_v1.types.RecognizeRequest, dict]):
519-
The request object. The top-level message sent by the
520-
client for the `Recognize` method.
519+
The request object. The top-level message sent by the client for the
520+
``Recognize`` method.
521521
config (google.cloud.speech_v1.types.RecognitionConfig):
522522
Required. Provides information to the
523523
recognizer that specifies how to process
@@ -640,8 +640,8 @@ def sample_long_running_recognize():
640640
641641
Args:
642642
request (Union[google.cloud.speech_v1.types.LongRunningRecognizeRequest, dict]):
643-
The request object. The top-level message sent by the
644-
client for the `LongRunningRecognize` method.
643+
The request object. The top-level message sent by the client for the
644+
``LongRunningRecognize`` method.
645645
config (google.cloud.speech_v1.types.RecognitionConfig):
646646
Required. Provides information to the
647647
recognizer that specifies how to process
@@ -775,13 +775,13 @@ def request_generator():
775775
776776
Args:
777777
requests (Iterator[google.cloud.speech_v1.types.StreamingRecognizeRequest]):
778-
The request object iterator. The top-level message sent by the
779-
client for the `StreamingRecognize` method. Multiple
780-
`StreamingRecognizeRequest` messages are sent. The first
781-
message must contain a `streaming_config` message and
782-
must not contain `audio_content`. All subsequent
783-
messages must contain `audio_content` and must not
784-
contain a `streaming_config` message.
778+
The request object iterator. The top-level message sent by the client for the
779+
``StreamingRecognize`` method. Multiple
780+
``StreamingRecognizeRequest`` messages are sent. The
781+
first message must contain a ``streaming_config``
782+
message and must not contain ``audio_content``. All
783+
subsequent messages must contain ``audio_content`` and
784+
must not contain a ``streaming_config`` message.
785785
retry (google.api_core.retry.Retry): Designation of what errors, if any,
786786
should be retried.
787787
timeout (float): The timeout for this request.

0 commit comments

Comments
 (0)