Skip to content

Commit 295c5b0

Browse files
docs: Minor formatting (#505)
* docs: Minor formatting PiperOrigin-RevId: 551578436 Source-Link: googleapis/googleapis@3f1a964 Source-Link: googleapis/googleapis-gen@a30fe8b Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYTMwZmU4YjY0NzU3YmUzNTIzNzhjNDEyZGMwNDZiZjY2NDNiM2E0OSJ9 * 🦉 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 5971964 commit 295c5b0

File tree

4 files changed

+32
-37
lines changed

4 files changed

+32
-37
lines changed

packages/google-cloud-translate/google/cloud/translate_v3/types/translation_service.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -765,18 +765,18 @@ class DocumentOutputConfig(proto.Message):
765765
766766
For a DocumentInputConfig.gcs_uri provided document, the
767767
output file will have a name according to its URI. For
768-
example: an input file with URI: "gs://a/b/c.[extension]"
768+
example: an input file with URI: ``gs://a/b/c.[extension]``
769769
stored in a gcs_destination bucket with name "my_bucket"
770770
will have an output URI:
771-
"gs://my_bucket/a_b_c\_[trg]_translations.[ext]", where
771+
``gs://my_bucket/a_b_c\_[trg]_translations.[ext]``, where
772772
773773
- [trg] corresponds to the translated file's language code,
774774
- [ext] corresponds to the translated file's extension
775775
according to its mime type.
776776
777777
If the document was directly provided through the request,
778778
then the output document will have the format:
779-
"gs://my_bucket/translated_document_[trg]_translations.[ext],
779+
``gs://my_bucket/translated_document_[trg]_translations.[ext]``,
780780
where
781781
782782
- [trg] corresponds to the translated file's language code,
@@ -788,7 +788,7 @@ class DocumentOutputConfig(proto.Message):
788788
but have ``glossary_translations`` instead of
789789
``translations``. For the previous example, its glossary URI
790790
would be:
791-
"gs://my_bucket/a_b_c\_[trg]_glossary_translations.[ext]".
791+
``gs://my_bucket/a_b_c\_[trg]_glossary_translations.[ext]``.
792792
793793
Thus the max number of output files will be 2 (Translated
794794
document, Glossary translated document).
@@ -1939,17 +1939,17 @@ class BatchDocumentOutputConfig(proto.Message):
19391939
19401940
The naming format of translation output files follows (for
19411941
target language code [trg]): ``translation_output``:
1942-
gs://translation_output/a_b_c\_[trg]\ *translation.[extension]
1942+
``gs://translation_output/a_b_c\_[trg]_translation.[extension]``
19431943
``glossary_translation_output``:
1944-
gs://translation_test/a_b_c*\ [trg]_glossary_translation.[extension]
1944+
``gs://translation_test/a_b_c\_[trg]_glossary_translation.[extension]``.
19451945
The output document will maintain the same file format as
19461946
the input document.
19471947
19481948
The naming format of error output files follows (for target
19491949
language code [trg]): ``error_output``:
1950-
gs://translation_test/a_b_c\_[trg]\ *errors.txt
1950+
``gs://translation_test/a_b_c\_[trg]_errors.txt``
19511951
``glossary_error_output``:
1952-
gs://translation_test/a_b_c*\ [trg]_glossary_translation.txt
1952+
``gs://translation_test/a_b_c\_[trg]_glossary_translation.txt``.
19531953
The error output is a txt file containing error details.
19541954
19551955
This field is a member of `oneof`_ ``destination``.

packages/google-cloud-translate/google/cloud/translate_v3beta1/services/translation_service/async_client.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -894,12 +894,10 @@ async def sample_batch_translate_document():
894894
on the ``request`` instance; if ``request`` is provided, this
895895
should not be set.
896896
source_language_code (:class:`str`):
897-
Required. The BCP-47 language code of
898-
the input document if known, for
899-
example, "en-US" or "sr-Latn". Supported
900-
language codes are listed in Language
901-
Support
902-
(https://cloud.google.com/translate/docs/languages).
897+
Required. The BCP-47 language code of the input document
898+
if known, for example, "en-US" or "sr-Latn". Supported
899+
language codes are listed in `Language
900+
Support <https://cloud.google.com/translate/docs/languages>`__.
903901
904902
This corresponds to the ``source_language_code`` field
905903
on the ``request`` instance; if ``request`` is provided, this

packages/google-cloud-translate/google/cloud/translate_v3beta1/services/translation_service/client.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1115,12 +1115,10 @@ def sample_batch_translate_document():
11151115
on the ``request`` instance; if ``request`` is provided, this
11161116
should not be set.
11171117
source_language_code (str):
1118-
Required. The BCP-47 language code of
1119-
the input document if known, for
1120-
example, "en-US" or "sr-Latn". Supported
1121-
language codes are listed in Language
1122-
Support
1123-
(https://cloud.google.com/translate/docs/languages).
1118+
Required. The BCP-47 language code of the input document
1119+
if known, for example, "en-US" or "sr-Latn". Supported
1120+
language codes are listed in `Language
1121+
Support <https://cloud.google.com/translate/docs/languages>`__.
11241122
11251123
This corresponds to the ``source_language_code`` field
11261124
on the ``request`` instance; if ``request`` is provided, this

packages/google-cloud-translate/google/cloud/translate_v3beta1/types/translation_service.py

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -651,10 +651,10 @@ class OutputConfig(proto.Message):
651651
directly written to the output file. If glossary is
652652
requested, a separate glossary_translations_file has format
653653
of
654-
gs://translation_test/a_b_c\_'trg'_glossary_translations.[extension]
654+
``gs://translation_test/a_b_c\_'trg'_glossary_translations.[extension]``
655655
656656
The format of errors file (for target language code 'trg')
657-
is: gs://translation_test/a_b_c\_'trg'_errors.[extension]
657+
is: ``gs://translation_test/a_b_c\_'trg'_errors.[extension]``
658658
659659
If the input file extension is tsv, errors_file contains the
660660
following: Column 1: ID of the request provided in the
@@ -667,7 +667,7 @@ class OutputConfig(proto.Message):
667667
If the input file extension is txt or html,
668668
glossary_error_file will be generated that contains error
669669
details. glossary_error_file has format of
670-
gs://translation_test/a_b_c\_'trg'_glossary_errors.[extension]
670+
``gs://translation_test/a_b_c\_'trg'_glossary_errors.[extension]``
671671
672672
This field is a member of `oneof`_ ``destination``.
673673
"""
@@ -757,18 +757,18 @@ class DocumentOutputConfig(proto.Message):
757757
758758
For a DocumentInputConfig.gcs_uri provided document, the
759759
output file will have a name according to its URI. For
760-
example: an input file with URI: "gs://a/b/c.[extension]"
760+
example: an input file with URI: ``gs://a/b/c.[extension]``
761761
stored in a gcs_destination bucket with name "my_bucket"
762762
will have an output URI:
763-
"gs://my_bucket/a_b_c\_[trg]_translations.[ext]", where
763+
``gs://my_bucket/a_b_c\_[trg]_translations.[ext]``, where
764764
765765
- [trg] corresponds to the translated file's language code,
766766
- [ext] corresponds to the translated file's extension
767767
according to its mime type.
768768
769769
If the document was directly provided through the request,
770770
then the output document will have the format:
771-
"gs://my_bucket/translated_document_[trg]_translations.[ext],
771+
``gs://my_bucket/translated_document_[trg]_translations.[ext]``,
772772
where
773773
774774
- [trg] corresponds to the translated file's language code,
@@ -780,7 +780,7 @@ class DocumentOutputConfig(proto.Message):
780780
but have ``glossary_translations`` instead of
781781
``translations``. For the previous example, its glossary URI
782782
would be:
783-
"gs://my_bucket/a_b_c\_[trg]_glossary_translations.[ext]".
783+
``gs://my_bucket/a_b_c\_[trg]_glossary_translations.[ext]``.
784784
785785
Thus the max number of output files will be 2 (Translated
786786
document, Glossary translated document).
@@ -1710,11 +1710,10 @@ class BatchTranslateDocumentRequest(proto.Message):
17101710
region (have the same location-id) can be used, otherwise an
17111711
INVALID_ARGUMENT (400) error is returned.
17121712
source_language_code (str):
1713-
Required. The BCP-47 language code of the
1714-
input document if known, for example, "en-US" or
1715-
"sr-Latn". Supported language codes are listed
1716-
in Language Support
1717-
(https://cloud.google.com/translate/docs/languages).
1713+
Required. The BCP-47 language code of the input document if
1714+
known, for example, "en-US" or "sr-Latn". Supported language
1715+
codes are listed in `Language
1716+
Support <https://cloud.google.com/translate/docs/languages>`__.
17181717
target_language_codes (MutableSequence[str]):
17191718
Required. The BCP-47 language code to use for
17201719
translation of the input document. Specify up to
@@ -1885,21 +1884,21 @@ class BatchDocumentOutputConfig(proto.Message):
18851884
Since index.csv will be keeping updated during the process,
18861885
please make sure there is no custom retention policy applied
18871886
on the output bucket that may avoid file updating.
1888-
(https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy)
1887+
(https://cloud.google.com/storage/docs/bucket-lock#retention-policy)
18891888
18901889
The naming format of translation output files follows (for
18911890
target language code [trg]): ``translation_output``:
1892-
gs://translation_output/a_b_c\_[trg]\ *translation.[extension]
1891+
``gs://translation_output/a_b_c\_[trg]_translation.[extension]``
18931892
``glossary_translation_output``:
1894-
gs://translation_test/a_b_c*\ [trg]_glossary_translation.[extension]
1893+
``gs://translation_test/a_b_c\_[trg]_glossary_translation.[extension]``.
18951894
The output document will maintain the same file format as
18961895
the input document.
18971896
18981897
The naming format of error output files follows (for target
18991898
language code [trg]): ``error_output``:
1900-
gs://translation_test/a_b_c\_[trg]\ *errors.txt
1899+
``gs://translation_test/a_b_c\_[trg]_errors.txt``
19011900
``glossary_error_output``:
1902-
gs://translation_test/a_b_c*\ [trg]_glossary_translation.txt
1901+
``gs://translation_test/a_b_c\_[trg]_glossary_translation.txt``
19031902
The error output is a txt file containing error details.
19041903
19051904
This field is a member of `oneof`_ ``destination``.

0 commit comments

Comments
 (0)