docs: fix docstring formatting (#111)

* docs: fix docstring formatting Committer: @parthea PiperOrigin-RevId: 405938813 Source-Link: googleapis/googleapis@3792423 Source-Link: googleapis/googleapis-gen@0e31788 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGUzMTc4ODQ5ZjhlYmVmY2U4OWIwODA3NDNkY2JlZjgxMmFmNTA2MyJ9 * 🦉 Updates from OwlBot 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>
googleapis · Oct 28, 2021 · fdf5dcd · fdf5dcd
1 parent 6e6d25e
commit fdf5dcd
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 19 deletions.
diff --git a/google/cloud/retail_v2/types/common.py b/google/cloud/retail_v2/types/common.py
@@ -215,7 +215,7 @@ class FulfillmentInfo(proto.Message):
 
             A maximum of 3000 values are allowed. Each value must be a
             string with a length limit of 30 characters, matching the
-            pattern [a-zA-Z0-9\_-]+, such as "store1" or "REGION-2".
+            pattern ``[a-zA-Z0-9\_-]+``, such as "store1" or "REGION-2".
             Otherwise, an INVALID_ARGUMENT error is returned.
     """
 
@@ -509,7 +509,7 @@ class Promotion(proto.Message):
 
             The value value must be a UTF-8 encoded string with a length
             limit of 128 characters, and match the pattern:
-            [a-zA-Z][a-zA-Z0-9\_]*. For example, id0LikeThis or
+            ``[a-zA-Z][a-zA-Z0-9\_]*``. For example, id0LikeThis or
             ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
             returned.
 

diff --git a/google/cloud/retail_v2/types/completion_service.py b/google/cloud/retail_v2/types/completion_service.py
@@ -58,19 +58,19 @@ class CompleteQueryRequest(proto.Message):
         device_type (str):
             The device type context for completion suggestions. It is
             useful to apply different suggestions on different device
-            types, e.g. DESKTOP, MOBILE. If it is empty, the suggestions
-            are across all device types.
+            types, e.g. ``DESKTOP``, ``MOBILE``. If it is empty, the
+            suggestions are across all device types.
 
             Supported formats:
 
-            -  UNKNOWN_DEVICE_TYPE
+            -  ``UNKNOWN_DEVICE_TYPE``
 
-            -  DESKTOP
+            -  ``DESKTOP``
 
-            -  MOBILE
+            -  ``MOBILE``
 
-            -  A customized string starts with OTHER\_, e.g.
-               OTHER_IPHONE.
+            -  A customized string starts with ``OTHER_``, e.g.
+               ``OTHER_IPHONE``.
         dataset (str):
             Determines which dataset to use for fetching completion.
             "user-data" will use the imported dataset through

diff --git a/google/cloud/retail_v2/types/import_config.py b/google/cloud/retail_v2/types/import_config.py
@@ -205,8 +205,8 @@ class ImportProductsRequest(proto.Message):
             Unique identifier provided by client, within the ancestor
             dataset scope. Ensures idempotency and used for request
             deduplication. Server-generated if unspecified. Up to 128
-            characters long and must match the pattern: "[a-zA-Z0-9\_]+".
-            This is returned as [Operation.name][] in
+            characters long and must match the pattern:
+            ``[a-zA-Z0-9\_]+``. This is returned as [Operation.name][] in
             [ImportMetadata][google.cloud.retail.v2.ImportMetadata].
 
             Only supported when

diff --git a/google/cloud/retail_v2/types/product.py b/google/cloud/retail_v2/types/product.py
@@ -261,8 +261,8 @@ class Product(proto.Message):
             -  The key must be a UTF-8 encoded string with a length
                limit of 128 characters.
             -  For indexable attribute, the key must match the pattern:
-               [a-zA-Z0-9][a-zA-Z0-9\_]*. For example, key0LikeThis or
-               KEY_1_LIKE_THIS.
+               ``[a-zA-Z0-9][a-zA-Z0-9\_]*``. For example, key0LikeThis
+               or KEY_1_LIKE_THIS.
         tags (Sequence[str]):
             Custom tags associated with the product.
 

diff --git a/google/cloud/retail_v2/types/product_service.py b/google/cloud/retail_v2/types/product_service.py
@@ -428,9 +428,9 @@ class AddFulfillmentPlacesRequest(proto.Message):
 
             At least 1 value is required, and a maximum of 2000 values
             are allowed. Each value must be a string with a length limit
-            of 10 characters, matching the pattern [a-zA-Z0-9\_-]+, such
-            as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT
-            error is returned.
+            of 10 characters, matching the pattern ``[a-zA-Z0-9\_-]+``,
+            such as "store1" or "REGION-2". Otherwise, an
+            INVALID_ARGUMENT error is returned.
 
             If the total number of place IDs exceeds 2000 for this
             [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]
@@ -517,9 +517,9 @@ class RemoveFulfillmentPlacesRequest(proto.Message):
 
             At least 1 value is required, and a maximum of 2000 values
             are allowed. Each value must be a string with a length limit
-            of 10 characters, matching the pattern [a-zA-Z0-9\_-]+, such
-            as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT
-            error is returned.
+            of 10 characters, matching the pattern ``[a-zA-Z0-9\_-]+``,
+            such as "store1" or "REGION-2". Otherwise, an
+            INVALID_ARGUMENT error is returned.
         remove_time (google.protobuf.timestamp_pb2.Timestamp):
             The time when the fulfillment updates are
             issued, used to prevent out-of-order updates on