Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

docs: update comments for ListVoicesRequest #244

Merged
merged 2 commits into from
Jan 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -213,15 +213,13 @@ async def list_voices(
language_code (:class:`str`):
Optional. Recommended.
`BCP-47 <https://www.rfc-editor.org/rfc/bcp/bcp47.txt>`__
language tag. If specified, the ListVoices call will
language tag. If not specified, the API will return all
supported voices. If specified, the ListVoices call will
only return voices that can be used to synthesize this
language_code. E.g. when specifying ``"en-NZ"``, you
will get supported ``"en-\*"`` voices; when specifying
``"no"``, you will get supported ``"no-\*"`` (Norwegian)
and ``"nb-\*"`` (Norwegian Bokmal) voices; specifying
``"zh"`` will also get supported ``"cmn-\*"`` voices;
specifying ``"zh-hk"`` will also get supported
``"yue-\*"`` voices.
language_code. For example, if you specify ``"en-NZ"``,
all ``"en-NZ"`` voices will be returned. If you specify
``"no"``, both ``"no-\*"`` (Norwegian) and ``"nb-\*"``
(Norwegian Bokmal) voices will be returned.

This corresponds to the ``language_code`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
14 changes: 6 additions & 8 deletions google/cloud/texttospeech_v1/services/text_to_speech/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -398,15 +398,13 @@ def list_voices(
language_code (str):
Optional. Recommended.
`BCP-47 <https://www.rfc-editor.org/rfc/bcp/bcp47.txt>`__
language tag. If specified, the ListVoices call will
language tag. If not specified, the API will return all
supported voices. If specified, the ListVoices call will
only return voices that can be used to synthesize this
language_code. E.g. when specifying ``"en-NZ"``, you
will get supported ``"en-\*"`` voices; when specifying
``"no"``, you will get supported ``"no-\*"`` (Norwegian)
and ``"nb-\*"`` (Norwegian Bokmal) voices; specifying
``"zh"`` will also get supported ``"cmn-\*"`` voices;
specifying ``"zh-hk"`` will also get supported
``"yue-\*"`` voices.
language_code. For example, if you specify ``"en-NZ"``,
all ``"en-NZ"`` voices will be returned. If you specify
``"no"``, both ``"no-\*"`` (Norwegian) and ``"nb-\*"``
(Norwegian Bokmal) voices will be returned.

This corresponds to the ``language_code`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
15 changes: 7 additions & 8 deletions google/cloud/texttospeech_v1/types/cloud_tts.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,13 @@ class ListVoicesRequest(proto.Message):
language_code (str):
Optional. Recommended.
`BCP-47 <https://www.rfc-editor.org/rfc/bcp/bcp47.txt>`__
language tag. If specified, the ListVoices call will only
return voices that can be used to synthesize this
language_code. E.g. when specifying ``"en-NZ"``, you will
get supported ``"en-\*"`` voices; when specifying ``"no"``,
you will get supported ``"no-\*"`` (Norwegian) and
``"nb-\*"`` (Norwegian Bokmal) voices; specifying ``"zh"``
will also get supported ``"cmn-\*"`` voices; specifying
``"zh-hk"`` will also get supported ``"yue-\*"`` voices.
language tag. If not specified, the API will return all
supported voices. If specified, the ListVoices call will
only return voices that can be used to synthesize this
language_code. For example, if you specify ``"en-NZ"``, all
``"en-NZ"`` voices will be returned. If you specify
``"no"``, both ``"no-\*"`` (Norwegian) and ``"nb-\*"``
(Norwegian Bokmal) voices will be returned.
"""

language_code = proto.Field(proto.STRING, number=1,)
Expand Down