docs: fix docstring formatting (#111)

- [ ] Regenerate this pull request now.

Committer: @parthea
PiperOrigin-RevId: 405938813

Source-Link: googleapis/googleapis@3792423

Source-Link: googleapis/googleapis-gen@0e31788
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGUzMTc4ODQ5ZjhlYmVmY2U4OWIwODA3NDNkY2JlZjgxMmFmNTA2MyJ9

protos/google/cloud/retail/v2/common.proto

@@ -173,8 +173,9 @@ message FulfillmentInfo {
   // [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2.FulfillmentInfo.type].
   //
   // 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". Otherwise, an INVALID_ARGUMENT error is returned.
+  // length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
+  // as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
+  // returned.
   repeated string place_ids = 2;
 }
 
@@ -414,7 +415,7 @@ message Promotion {
   // ID of the promotion. For example, "free gift".
   //
   // 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,
+  // characters, and match the pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example,
   // id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
   // returned.
   //

protos/google/cloud/retail/v2/completion_service.proto

@@ -110,18 +110,18 @@ message CompleteQueryRequest {
 
   // 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
+  // `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`.
   string device_type = 4;
 
   // Determines which dataset to use for fetching completion. "user-data" will

protos/google/cloud/retail/v2/import_config.proto

@@ -183,7 +183,7 @@ message ImportProductsRequest {
   // 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
+  // the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
   // [ImportMetadata][google.cloud.retail.v2.ImportMetadata].
   //
   // Only supported when

protos/google/cloud/retail/v2/product.proto

@@ -320,7 +320,7 @@ message Product {
   // * 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.
   map<string, CustomAttribute> attributes = 12;
 
   // Custom tags associated with the product.

protos/google/cloud/retail/v2/product_service.proto

@@ -536,7 +536,7 @@ message AddFulfillmentPlacesRequest {
   //
   // 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
+  // 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
@@ -611,7 +611,7 @@ message RemoveFulfillmentPlacesRequest {
   //
   // 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
+  // the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
   // INVALID_ARGUMENT error is returned.
   repeated string place_ids = 3 [(google.api.field_behavior) = REQUIRED];
 

protos/google/cloud/retail/v2alpha/common.proto

@@ -176,8 +176,9 @@ message FulfillmentInfo {
   // [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
   //
   // 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". Otherwise, an INVALID_ARGUMENT error is returned.
+  // length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
+  // as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
+  // returned.
   repeated string place_ids = 2;
 }
 
@@ -423,7 +424,7 @@ message Promotion {
   // ID of the promotion. For example, "free gift".
   //
   // 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,
+  // characters, and match the pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example,
   // id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
   // returned.
   //

protos/google/cloud/retail/v2alpha/completion_service.proto

@@ -110,18 +110,18 @@ message CompleteQueryRequest {
 
   // 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
+  // `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`.
   string device_type = 4;
 
   // Determines which dataset to use for fetching completion. "user-data" will

protos/google/cloud/retail/v2alpha/import_config.proto

@@ -183,7 +183,7 @@ message ImportProductsRequest {
   // 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
+  // the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
   // [ImportMetadata][google.cloud.retail.v2alpha.ImportMetadata].
   //
   // Only supported when

protos/google/cloud/retail/v2alpha/product.proto

@@ -327,7 +327,7 @@ message Product {
   // * 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.
   map<string, CustomAttribute> attributes = 12;
 
   // Custom tags associated with the product.

protos/google/cloud/retail/v2alpha/product_service.proto

@@ -565,7 +565,7 @@ message AddFulfillmentPlacesRequest {
   //
   // 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
+  // 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
@@ -640,7 +640,7 @@ message RemoveFulfillmentPlacesRequest {
   //
   // 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
+  // the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
   // INVALID_ARGUMENT error is returned.
   repeated string place_ids = 3 [(google.api.field_behavior) = REQUIRED];
 

protos/google/cloud/retail/v2beta/common.proto

@@ -176,8 +176,9 @@ message FulfillmentInfo {
   // [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2beta.FulfillmentInfo.type].
   //
   // 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". Otherwise, an INVALID_ARGUMENT error is returned.
+  // length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
+  // as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
+  // returned.
   repeated string place_ids = 2;
 }
 
@@ -422,7 +423,7 @@ message Promotion {
   // ID of the promotion. For example, "free gift".
   //
   // 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,
+  // characters, and match the pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example,
   // id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
   // returned.
   //

protos/google/cloud/retail/v2beta/completion_service.proto

@@ -110,18 +110,18 @@ message CompleteQueryRequest {
 
   // 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
+  // `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`.
   string device_type = 4;
 
   // Determines which dataset to use for fetching completion. "user-data" will

protos/google/cloud/retail/v2beta/import_config.proto

@@ -183,7 +183,7 @@ message ImportProductsRequest {
   // 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
+  // the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
   // [ImportMetadata][google.cloud.retail.v2beta.ImportMetadata].
   //
   // Only supported when

protos/google/cloud/retail/v2beta/product.proto

@@ -326,7 +326,7 @@ message Product {
   // * 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.
   map<string, CustomAttribute> attributes = 12;
 
   // Custom tags associated with the product.

protos/google/cloud/retail/v2beta/product_service.proto

@@ -541,7 +541,7 @@ message AddFulfillmentPlacesRequest {
   //
   // 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
+  // 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
@@ -616,7 +616,7 @@ message RemoveFulfillmentPlacesRequest {
   //
   // 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
+  // the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
   // INVALID_ARGUMENT error is returned.
   repeated string place_ids = 3 [(google.api.field_behavior) = REQUIRED];
 

samples/generated/v2/completion_service.complete_query.js

@@ -51,13 +51,13 @@ function main(catalog, query) {
   /**
    *  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
+   *  `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
    *  types.
    *  Supported formats:
-   *  * UNKNOWN_DEVICE_TYPE
-   *  * DESKTOP
-   *  * MOBILE
-   *  * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+   *  * `UNKNOWN_DEVICE_TYPE`
+   *  * `DESKTOP`
+   *  * `MOBILE`
+   *  * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
    */
   // const deviceType = 'abc123'
   /**

samples/generated/v2/product_service.add_fulfillment_places.js

@@ -55,7 +55,7 @@ function main(product, type, placeIds) {
    *  IDs will be automatically ignored.
    *  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
+   *  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] after

samples/generated/v2/product_service.import_products.js

@@ -30,7 +30,7 @@ function main(parent, inputConfig) {
    *  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
+   *  the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
    *  [ImportMetadata][google.cloud.retail.v2.ImportMetadata].
    *  Only supported when
    *  [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode]

samples/generated/v2/product_service.remove_fulfillment_places.js

@@ -54,7 +54,7 @@ function main(product, type, placeIds) {
    *  [type][google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type].
    *  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
+   *  the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    *  INVALID_ARGUMENT error is returned.
    */
   // const placeIds = 'abc123'

samples/generated/v2alpha/completion_service.complete_query.js

@@ -51,13 +51,13 @@ function main(catalog, query) {
   /**
    *  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
+   *  `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
    *  types.
    *  Supported formats:
-   *  * UNKNOWN_DEVICE_TYPE
-   *  * DESKTOP
-   *  * MOBILE
-   *  * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+   *  * `UNKNOWN_DEVICE_TYPE`
+   *  * `DESKTOP`
+   *  * `MOBILE`
+   *  * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
    */
   // const deviceType = 'abc123'
   /**

samples/generated/v2alpha/product_service.add_fulfillment_places.js

@@ -55,7 +55,7 @@ function main(product, type, placeIds) {
    *  Duplicate IDs will be automatically ignored.
    *  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
+   *  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.v2alpha.AddFulfillmentPlacesRequest.type] after

samples/generated/v2alpha/product_service.import_products.js

@@ -30,7 +30,7 @@ function main(parent, inputConfig) {
    *  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
+   *  the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
    *  [ImportMetadata][google.cloud.retail.v2alpha.ImportMetadata].
    *  Only supported when
    *  [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2alpha.ImportProductsRequest.reconciliation_mode]

samples/generated/v2alpha/product_service.remove_fulfillment_places.js

@@ -54,7 +54,7 @@ function main(product, type, placeIds) {
    *  [type][google.cloud.retail.v2alpha.RemoveFulfillmentPlacesRequest.type].
    *  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
+   *  the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    *  INVALID_ARGUMENT error is returned.
    */
   // const placeIds = 'abc123'

samples/generated/v2beta/completion_service.complete_query.js

@@ -51,13 +51,13 @@ function main(catalog, query) {
   /**
    *  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
+   *  `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
    *  types.
    *  Supported formats:
-   *  * UNKNOWN_DEVICE_TYPE
-   *  * DESKTOP
-   *  * MOBILE
-   *  * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+   *  * `UNKNOWN_DEVICE_TYPE`
+   *  * `DESKTOP`
+   *  * `MOBILE`
+   *  * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
    */
   // const deviceType = 'abc123'
   /**

samples/generated/v2beta/product_service.add_fulfillment_places.js

@@ -55,7 +55,7 @@ function main(product, type, placeIds) {
    *  Duplicate IDs will be automatically ignored.
    *  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
+   *  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.v2beta.AddFulfillmentPlacesRequest.type] after

samples/generated/v2beta/product_service.import_products.js

@@ -30,7 +30,7 @@ function main(parent, inputConfig) {
    *  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
+   *  the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
    *  [ImportMetadata][google.cloud.retail.v2beta.ImportMetadata].
    *  Only supported when
    *  [ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2beta.ImportProductsRequest.reconciliation_mode]

samples/generated/v2beta/product_service.remove_fulfillment_places.js

@@ -54,7 +54,7 @@ function main(product, type, placeIds) {
    *  [type][google.cloud.retail.v2beta.RemoveFulfillmentPlacesRequest.type].
    *  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
+   *  the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    *  INVALID_ARGUMENT error is returned.
    */
   // const placeIds = 'abc123'