Skip to content

Commit 3792423

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: fix docstring formatting
Committer: @parthea PiperOrigin-RevId: 405938813
1 parent 2781c73 commit 3792423

15 files changed

Lines changed: 39 additions & 36 deletions

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,9 @@ message FulfillmentInfo {
173173
// [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2.FulfillmentInfo.type].
174174
//
175175
// A maximum of 3000 values are allowed. Each value must be a string with a
176-
// length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as
177-
// "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
176+
// length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
177+
// as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
178+
// returned.
178179
repeated string place_ids = 2;
179180
}
180181

@@ -414,7 +415,7 @@ message Promotion {
414415
// ID of the promotion. For example, "free gift".
415416
//
416417
// The value value must be a UTF-8 encoded string with a length limit of 128
417-
// characters, and match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example,
418+
// characters, and match the pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example,
418419
// id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
419420
// returned.
420421
//

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,18 @@ message CompleteQueryRequest {
110110

111111
// The device type context for completion suggestions.
112112
// It is useful to apply different suggestions on different device types, e.g.
113-
// DESKTOP, MOBILE. If it is empty, the suggestions are across all device
113+
// `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
114114
// types.
115115
//
116116
// Supported formats:
117117
//
118-
// * UNKNOWN_DEVICE_TYPE
118+
// * `UNKNOWN_DEVICE_TYPE`
119119
//
120-
// * DESKTOP
120+
// * `DESKTOP`
121121
//
122-
// * MOBILE
122+
// * `MOBILE`
123123
//
124-
// * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
124+
// * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
125125
string device_type = 4;
126126

127127
// Determines which dataset to use for fetching completion. "user-data" will

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ message ImportProductsRequest {
183183
// Unique identifier provided by client, within the ancestor
184184
// dataset scope. Ensures idempotency and used for request deduplication.
185185
// Server-generated if unspecified. Up to 128 characters long and must match
186-
// the pattern: "[a-zA-Z0-9_]+". This is returned as [Operation.name][] in
186+
// the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
187187
// [ImportMetadata][google.cloud.retail.v2.ImportMetadata].
188188
//
189189
// Only supported when

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ message Product {
320320
// * The key must be a UTF-8 encoded string with a length limit of 128
321321
// characters.
322322
// * For indexable attribute, the key must match the pattern:
323-
// [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
323+
// `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, key0LikeThis or KEY_1_LIKE_THIS.
324324
map<string, CustomAttribute> attributes = 12;
325325

326326
// Custom tags associated with the product.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,7 @@ message AddFulfillmentPlacesRequest {
536536
//
537537
// At least 1 value is required, and a maximum of 2000 values are allowed.
538538
// Each value must be a string with a length limit of 10 characters, matching
539-
// the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
539+
// the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
540540
// INVALID_ARGUMENT error is returned.
541541
//
542542
// If the total number of place IDs exceeds 2000 for this
@@ -611,7 +611,7 @@ message RemoveFulfillmentPlacesRequest {
611611
//
612612
// At least 1 value is required, and a maximum of 2000 values are allowed.
613613
// Each value must be a string with a length limit of 10 characters, matching
614-
// the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
614+
// the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
615615
// INVALID_ARGUMENT error is returned.
616616
repeated string place_ids = 3 [(google.api.field_behavior) = REQUIRED];
617617

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,9 @@ message FulfillmentInfo {
176176
// [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2alpha.FulfillmentInfo.type].
177177
//
178178
// A maximum of 3000 values are allowed. Each value must be a string with a
179-
// length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as
180-
// "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
179+
// length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
180+
// as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
181+
// returned.
181182
repeated string place_ids = 2;
182183
}
183184

@@ -423,7 +424,7 @@ message Promotion {
423424
// ID of the promotion. For example, "free gift".
424425
//
425426
// The value value must be a UTF-8 encoded string with a length limit of 128
426-
// characters, and match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example,
427+
// characters, and match the pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example,
427428
// id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
428429
// returned.
429430
//

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,18 @@ message CompleteQueryRequest {
110110

111111
// The device type context for completion suggestions.
112112
// It is useful to apply different suggestions on different device types, e.g.
113-
// DESKTOP, MOBILE. If it is empty, the suggestions are across all device
113+
// `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
114114
// types.
115115
//
116116
// Supported formats:
117117
//
118-
// * UNKNOWN_DEVICE_TYPE
118+
// * `UNKNOWN_DEVICE_TYPE`
119119
//
120-
// * DESKTOP
120+
// * `DESKTOP`
121121
//
122-
// * MOBILE
122+
// * `MOBILE`
123123
//
124-
// * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
124+
// * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
125125
string device_type = 4;
126126

127127
// Determines which dataset to use for fetching completion. "user-data" will

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ message ImportProductsRequest {
183183
// Unique identifier provided by client, within the ancestor
184184
// dataset scope. Ensures idempotency and used for request deduplication.
185185
// Server-generated if unspecified. Up to 128 characters long and must match
186-
// the pattern: "[a-zA-Z0-9_]+". This is returned as [Operation.name][] in
186+
// the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
187187
// [ImportMetadata][google.cloud.retail.v2alpha.ImportMetadata].
188188
//
189189
// Only supported when

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ message Product {
327327
// * The key must be a UTF-8 encoded string with a length limit of 128
328328
// characters.
329329
// * For indexable attribute, the key must match the pattern:
330-
// [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
330+
// `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, key0LikeThis or KEY_1_LIKE_THIS.
331331
map<string, CustomAttribute> attributes = 12;
332332

333333
// Custom tags associated with the product.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,7 @@ message AddFulfillmentPlacesRequest {
565565
//
566566
// At least 1 value is required, and a maximum of 2000 values are allowed.
567567
// Each value must be a string with a length limit of 10 characters, matching
568-
// the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
568+
// the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
569569
// INVALID_ARGUMENT error is returned.
570570
//
571571
// If the total number of place IDs exceeds 2000 for this
@@ -640,7 +640,7 @@ message RemoveFulfillmentPlacesRequest {
640640
//
641641
// At least 1 value is required, and a maximum of 2000 values are allowed.
642642
// Each value must be a string with a length limit of 10 characters, matching
643-
// the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
643+
// the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
644644
// INVALID_ARGUMENT error is returned.
645645
repeated string place_ids = 3 [(google.api.field_behavior) = REQUIRED];
646646

0 commit comments

Comments
 (0)