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

docs: Fix formatting of request arg in docstring #512

Merged
merged 2 commits into from
Mar 23, 2023
Merged

docs: Fix formatting of request arg in docstring #512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33056a5
docs: Fix formatting of request arg in docstring
gcf-owl-bot[bot] Mar 22, 2023
ae82a34
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions google/cloud/speech_v1/services/adaptation/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,8 +259,8 @@ async def sample_create_phrase_set():

Args:
request (Optional[Union[google.cloud.speech_v1.types.CreatePhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`CreatePhraseSet` method.
The request object. Message sent by the client for the ``CreatePhraseSet``
method.
parent (:class:`str`):
Required. The parent resource where this phrase set will
be created. Format:
Expand Down Expand Up @@ -396,8 +396,8 @@ async def sample_get_phrase_set():

Args:
request (Optional[Union[google.cloud.speech_v1.types.GetPhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`GetPhraseSet` method.
The request object. Message sent by the client for the ``GetPhraseSet``
method.
name (:class:`str`):
Required. The name of the phrase set to retrieve.
Format:
Expand Down Expand Up @@ -512,8 +512,8 @@ async def sample_list_phrase_set():

Args:
request (Optional[Union[google.cloud.speech_v1.types.ListPhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`ListPhraseSet` method.
The request object. Message sent by the client for the ``ListPhraseSet``
method.
parent (:class:`str`):
Required. The parent, which owns this collection of
phrase set. Format:
Expand Down Expand Up @@ -638,8 +638,8 @@ async def sample_update_phrase_set():

Args:
request (Optional[Union[google.cloud.speech_v1.types.UpdatePhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`UpdatePhraseSet` method.
The request object. Message sent by the client for the ``UpdatePhraseSet``
method.
phrase_set (:class:`google.cloud.speech_v1.types.PhraseSet`):
Required. The phrase set to update.

Expand Down Expand Up @@ -761,8 +761,8 @@ async def sample_delete_phrase_set():

Args:
request (Optional[Union[google.cloud.speech_v1.types.DeletePhraseSetRequest, dict]]):
The request object. Message sent by the client for the
`DeletePhraseSet` method.
The request object. Message sent by the client for the ``DeletePhraseSet``
method.
name (:class:`str`):
Required. The name of the phrase set to delete. Format:

Expand Down Expand Up @@ -860,8 +860,8 @@ async def sample_create_custom_class():

Args:
request (Optional[Union[google.cloud.speech_v1.types.CreateCustomClassRequest, dict]]):
The request object. Message sent by the client for the
`CreateCustomClass` method.
The request object. Message sent by the client for the ``CreateCustomClass``
method.
parent (:class:`str`):
Required. The parent resource where this custom class
will be created. Format:
Expand Down Expand Up @@ -1001,8 +1001,8 @@ async def sample_get_custom_class():

Args:
request (Optional[Union[google.cloud.speech_v1.types.GetCustomClassRequest, dict]]):
The request object. Message sent by the client for the
`GetCustomClass` method.
The request object. Message sent by the client for the ``GetCustomClass``
method.
name (:class:`str`):
Required. The name of the custom class to retrieve.
Format:
Expand Down Expand Up @@ -1113,8 +1113,8 @@ async def sample_list_custom_classes():

Args:
request (Optional[Union[google.cloud.speech_v1.types.ListCustomClassesRequest, dict]]):
The request object. Message sent by the client for the
`ListCustomClasses` method.
The request object. Message sent by the client for the ``ListCustomClasses``
method.
parent (:class:`str`):
Required. The parent, which owns this collection of
custom classes. Format:
Expand Down Expand Up @@ -1239,8 +1239,8 @@ async def sample_update_custom_class():

Args:
request (Optional[Union[google.cloud.speech_v1.types.UpdateCustomClassRequest, dict]]):
The request object. Message sent by the client for the
`UpdateCustomClass` method.
The request object. Message sent by the client for the ``UpdateCustomClass``
method.
custom_class (:class:`google.cloud.speech_v1.types.CustomClass`):
Required. The custom class to update.

Expand Down Expand Up @@ -1366,8 +1366,8 @@ async def sample_delete_custom_class():

Args:
request (Optional[Union[google.cloud.speech_v1.types.DeleteCustomClassRequest, dict]]):
The request object. Message sent by the client for the
`DeleteCustomClass` method.
The request object. Message sent by the client for the ``DeleteCustomClass``
method.
name (:class:`str`):
Required. The name of the custom class to delete.
Format:
Expand Down
40 changes: 20 additions & 20 deletions google/cloud/speech_v1/services/adaptation/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,8 +512,8 @@ def sample_create_phrase_set():

Args:
request (Union[google.cloud.speech_v1.types.CreatePhraseSetRequest, dict]):
The request object. Message sent by the client for the
`CreatePhraseSet` method.
The request object. Message sent by the client for the ``CreatePhraseSet``
method.
parent (str):
Required. The parent resource where this phrase set will
be created. Format:
Expand Down Expand Up @@ -649,8 +649,8 @@ def sample_get_phrase_set():

Args:
request (Union[google.cloud.speech_v1.types.GetPhraseSetRequest, dict]):
The request object. Message sent by the client for the
`GetPhraseSet` method.
The request object. Message sent by the client for the ``GetPhraseSet``
method.
name (str):
Required. The name of the phrase set to retrieve.
Format:
Expand Down Expand Up @@ -765,8 +765,8 @@ def sample_list_phrase_set():

Args:
request (Union[google.cloud.speech_v1.types.ListPhraseSetRequest, dict]):
The request object. Message sent by the client for the
`ListPhraseSet` method.
The request object. Message sent by the client for the ``ListPhraseSet``
method.
parent (str):
Required. The parent, which owns this collection of
phrase set. Format:
Expand Down Expand Up @@ -891,8 +891,8 @@ def sample_update_phrase_set():

Args:
request (Union[google.cloud.speech_v1.types.UpdatePhraseSetRequest, dict]):
The request object. Message sent by the client for the
`UpdatePhraseSet` method.
The request object. Message sent by the client for the ``UpdatePhraseSet``
method.
phrase_set (google.cloud.speech_v1.types.PhraseSet):
Required. The phrase set to update.

Expand Down Expand Up @@ -1014,8 +1014,8 @@ def sample_delete_phrase_set():

Args:
request (Union[google.cloud.speech_v1.types.DeletePhraseSetRequest, dict]):
The request object. Message sent by the client for the
`DeletePhraseSet` method.
The request object. Message sent by the client for the ``DeletePhraseSet``
method.
name (str):
Required. The name of the phrase set to delete. Format:

Expand Down Expand Up @@ -1113,8 +1113,8 @@ def sample_create_custom_class():

Args:
request (Union[google.cloud.speech_v1.types.CreateCustomClassRequest, dict]):
The request object. Message sent by the client for the
`CreateCustomClass` method.
The request object. Message sent by the client for the ``CreateCustomClass``
method.
parent (str):
Required. The parent resource where this custom class
will be created. Format:
Expand Down Expand Up @@ -1254,8 +1254,8 @@ def sample_get_custom_class():

Args:
request (Union[google.cloud.speech_v1.types.GetCustomClassRequest, dict]):
The request object. Message sent by the client for the
`GetCustomClass` method.
The request object. Message sent by the client for the ``GetCustomClass``
method.
name (str):
Required. The name of the custom class to retrieve.
Format:
Expand Down Expand Up @@ -1366,8 +1366,8 @@ def sample_list_custom_classes():

Args:
request (Union[google.cloud.speech_v1.types.ListCustomClassesRequest, dict]):
The request object. Message sent by the client for the
`ListCustomClasses` method.
The request object. Message sent by the client for the ``ListCustomClasses``
method.
parent (str):
Required. The parent, which owns this collection of
custom classes. Format:
Expand Down Expand Up @@ -1492,8 +1492,8 @@ def sample_update_custom_class():

Args:
request (Union[google.cloud.speech_v1.types.UpdateCustomClassRequest, dict]):
The request object. Message sent by the client for the
`UpdateCustomClass` method.
The request object. Message sent by the client for the ``UpdateCustomClass``
method.
custom_class (google.cloud.speech_v1.types.CustomClass):
Required. The custom class to update.

Expand Down Expand Up @@ -1619,8 +1619,8 @@ def sample_delete_custom_class():

Args:
request (Union[google.cloud.speech_v1.types.DeleteCustomClassRequest, dict]):
The request object. Message sent by the client for the
`DeleteCustomClass` method.
The request object. Message sent by the client for the ``DeleteCustomClass``
method.
name (str):
Required. The name of the custom class to delete.
Format:
Expand Down
10 changes: 0 additions & 10 deletions google/cloud/speech_v1/services/adaptation/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,6 @@ def __call__(
request (~.cloud_speech_adaptation.CreateCustomClassRequest):
The request object. Message sent by the client for the ``CreateCustomClass``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -646,7 +645,6 @@ def __call__(
request (~.cloud_speech_adaptation.CreatePhraseSetRequest):
The request object. Message sent by the client for the ``CreatePhraseSet``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -748,7 +746,6 @@ def __call__(
request (~.cloud_speech_adaptation.DeleteCustomClassRequest):
The request object. Message sent by the client for the ``DeleteCustomClass``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -826,7 +823,6 @@ def __call__(
request (~.cloud_speech_adaptation.DeletePhraseSetRequest):
The request object. Message sent by the client for the ``DeletePhraseSet``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -904,7 +900,6 @@ def __call__(
request (~.cloud_speech_adaptation.GetCustomClassRequest):
The request object. Message sent by the client for the ``GetCustomClass``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1001,7 +996,6 @@ def __call__(
request (~.cloud_speech_adaptation.GetPhraseSetRequest):
The request object. Message sent by the client for the ``GetPhraseSet``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1092,7 +1086,6 @@ def __call__(
request (~.cloud_speech_adaptation.ListCustomClassesRequest):
The request object. Message sent by the client for the ``ListCustomClasses``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1184,7 +1177,6 @@ def __call__(
request (~.cloud_speech_adaptation.ListPhraseSetRequest):
The request object. Message sent by the client for the ``ListPhraseSet``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1274,7 +1266,6 @@ def __call__(
request (~.cloud_speech_adaptation.UpdateCustomClassRequest):
The request object. Message sent by the client for the ``UpdateCustomClass``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1380,7 +1371,6 @@ def __call__(
request (~.cloud_speech_adaptation.UpdatePhraseSetRequest):
The request object. Message sent by the client for the ``UpdatePhraseSet``
method.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
22 changes: 11 additions & 11 deletions google/cloud/speech_v1/services/speech/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,8 @@ async def sample_recognize():

Args:
request (Optional[Union[google.cloud.speech_v1.types.RecognizeRequest, dict]]):
The request object. The top-level message sent by the
client for the `Recognize` method.
The request object. The top-level message sent by the client for the
``Recognize`` method.
config (:class:`google.cloud.speech_v1.types.RecognitionConfig`):
Required. Provides information to the
recognizer that specifies how to process
Expand Down Expand Up @@ -394,8 +394,8 @@ async def sample_long_running_recognize():

Args:
request (Optional[Union[google.cloud.speech_v1.types.LongRunningRecognizeRequest, dict]]):
The request object. The top-level message sent by the
client for the `LongRunningRecognize` method.
The request object. The top-level message sent by the client for the
``LongRunningRecognize`` method.
config (:class:`google.cloud.speech_v1.types.RecognitionConfig`):
Required. Provides information to the
recognizer that specifies how to process
Expand Down Expand Up @@ -531,13 +531,13 @@ def request_generator():

Args:
requests (AsyncIterator[`google.cloud.speech_v1.types.StreamingRecognizeRequest`]):
The request object AsyncIterator. The top-level message sent by the
client for the `StreamingRecognize` method. Multiple
`StreamingRecognizeRequest` messages are sent. The first
message must contain a `streaming_config` message and
must not contain `audio_content`. All subsequent
messages must contain `audio_content` and must not
contain a `streaming_config` message.
The request object AsyncIterator. The top-level message sent by the client for the
``StreamingRecognize`` method. Multiple
``StreamingRecognizeRequest`` messages are sent. The
first message must contain a ``streaming_config``
message and must not contain ``audio_content``. All
subsequent messages must contain ``audio_content`` and
must not contain a ``streaming_config`` message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
22 changes: 11 additions & 11 deletions google/cloud/speech_v1/services/speech/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,8 +516,8 @@ def sample_recognize():

Args:
request (Union[google.cloud.speech_v1.types.RecognizeRequest, dict]):
The request object. The top-level message sent by the
client for the `Recognize` method.
The request object. The top-level message sent by the client for the
``Recognize`` method.
config (google.cloud.speech_v1.types.RecognitionConfig):
Required. Provides information to the
recognizer that specifies how to process
Expand Down Expand Up @@ -640,8 +640,8 @@ def sample_long_running_recognize():

Args:
request (Union[google.cloud.speech_v1.types.LongRunningRecognizeRequest, dict]):
The request object. The top-level message sent by the
client for the `LongRunningRecognize` method.
The request object. The top-level message sent by the client for the
``LongRunningRecognize`` method.
config (google.cloud.speech_v1.types.RecognitionConfig):
Required. Provides information to the
recognizer that specifies how to process
Expand Down Expand Up @@ -775,13 +775,13 @@ def request_generator():

Args:
requests (Iterator[google.cloud.speech_v1.types.StreamingRecognizeRequest]):
The request object iterator. The top-level message sent by the
client for the `StreamingRecognize` method. Multiple
`StreamingRecognizeRequest` messages are sent. The first
message must contain a `streaming_config` message and
must not contain `audio_content`. All subsequent
messages must contain `audio_content` and must not
contain a `streaming_config` message.
The request object iterator. The top-level message sent by the client for the
``StreamingRecognize`` method. Multiple
``StreamingRecognizeRequest`` messages are sent. The
first message must contain a ``streaming_config``
message and must not contain ``audio_content``. All
subsequent messages must contain ``audio_content`` and
must not contain a ``streaming_config`` message.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Loading