From 2452fdf6f1b95cde5ae883fe2ec2e7a48f12f103 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Mon, 1 Nov 2021 16:34:34 -0700 Subject: [PATCH] docs: fix docstring formatting (#378) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: fix docstring formatting Committer: @parthea PiperOrigin-RevId: 406427586 Source-Link: https://github.com/googleapis/googleapis/commit/c2b080f3208bacdfe93810ac2ef14d0dcee24b1d Source-Link: https://github.com/googleapis/googleapis-gen/commit/1b459e28d07af7a0c55d65a20ea45eb116d1868c Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMWI0NTllMjhkMDdhZjdhMGM1NWQ2NWEyMGVhNDVlYjExNmQxODY4YyJ9 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot --- .../protos/google/cloud/talent/v4/job.proto | 2 +- .../protos/google/cloud/talent/v4/job_service.proto | 2 +- .../protos/google/cloud/talent/v4beta1/job.proto | 2 +- .../protos/google/cloud/talent/v4beta1/job_service.proto | 2 +- .../protos/google/cloud/talent/v4beta1/profile_service.proto | 2 +- .../samples/generated/v4/job_service.search_jobs.js | 2 +- .../samples/generated/v4/job_service.search_jobs_for_alert.js | 2 +- .../samples/generated/v4beta1/job_service.search_jobs.js | 2 +- .../generated/v4beta1/job_service.search_jobs_for_alert.js | 2 +- .../generated/v4beta1/profile_service.search_profiles.js | 2 +- packages/google-cloud-talent/src/v4/job_service_client.ts | 4 ++-- .../google-cloud-talent/src/v4beta1/job_service_client.ts | 4 ++-- .../google-cloud-talent/src/v4beta1/profile_service_client.ts | 2 +- 13 files changed, 15 insertions(+), 15 deletions(-) diff --git a/packages/google-cloud-talent/protos/google/cloud/talent/v4/job.proto b/packages/google-cloud-talent/protos/google/cloud/talent/v4/job.proto index f39df6ac70f..b926c38554a 100644 --- a/packages/google-cloud-talent/protos/google/cloud/talent/v4/job.proto +++ b/packages/google-cloud-talent/protos/google/cloud/talent/v4/job.proto @@ -187,7 +187,7 @@ message Job { // attributes that are not covered by the provided structured fields. // // The keys of the map are strings up to 64 bytes and must match the - // pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or + // pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example, key0LikeThis or // KEY_1_LIKE_THIS. // // At most 100 filterable and at most 100 unfilterable keys are supported. diff --git a/packages/google-cloud-talent/protos/google/cloud/talent/v4/job_service.proto b/packages/google-cloud-talent/protos/google/cloud/talent/v4/job_service.proto index 26d2cf96fb2..5572b7c1258 100644 --- a/packages/google-cloud-talent/protos/google/cloud/talent/v4/job_service.proto +++ b/packages/google-cloud-talent/protos/google/cloud/talent/v4/job_service.proto @@ -533,7 +533,7 @@ message SearchJobsRequest { // // Data types: // - // * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. + // * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. // * String: string like "any string with backslash escape for quote(\")." // * Number: whole number and floating point number like 10, -1 and -0.01. // * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/job.proto b/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/job.proto index b2ffa2bc8f0..b1b24c64f55 100644 --- a/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/job.proto +++ b/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/job.proto @@ -186,7 +186,7 @@ message Job { // attributes that are not covered by the provided structured fields. // // The keys of the map are strings up to 64 bytes and must match the - // pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or + // pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example, key0LikeThis or // KEY_1_LIKE_THIS. // // At most 100 filterable and at most 100 unfilterable keys are supported. diff --git a/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/job_service.proto b/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/job_service.proto index 148e64865d9..5d26db9094a 100644 --- a/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/job_service.proto +++ b/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/job_service.proto @@ -557,7 +557,7 @@ message SearchJobsRequest { // // Data types: // - // * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. + // * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. // * String: string like "any string with backslash escape for quote(\")." // * Number: whole number and floating point number like 10, -1 and -0.01. // * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/profile_service.proto b/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/profile_service.proto index 4a153fd2e69..0562a55906d 100644 --- a/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/profile_service.proto +++ b/packages/google-cloud-talent/protos/google/cloud/talent/v4beta1/profile_service.proto @@ -309,7 +309,7 @@ message SearchProfilesRequest { // // Data types: // - // * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. + // * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. // * String: string like "any string with backslash escape for quote(\")." // * Number: whole number and floating point number like 10, -1 and -0.01. // * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/samples/generated/v4/job_service.search_jobs.js b/packages/google-cloud-talent/samples/generated/v4/job_service.search_jobs.js index 5e89d9a9c32..be4e805178f 100644 --- a/packages/google-cloud-talent/samples/generated/v4/job_service.search_jobs.js +++ b/packages/google-cloud-talent/samples/generated/v4/job_service.search_jobs.js @@ -57,7 +57,7 @@ function main(parent, requestMetadata) { * * `count(numeric_histogram_facet, list of buckets)`: Count the number of * matching entities within each bucket. * Data types: - * * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. + * * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/samples/generated/v4/job_service.search_jobs_for_alert.js b/packages/google-cloud-talent/samples/generated/v4/job_service.search_jobs_for_alert.js index c56f628b63e..9b5bc409164 100644 --- a/packages/google-cloud-talent/samples/generated/v4/job_service.search_jobs_for_alert.js +++ b/packages/google-cloud-talent/samples/generated/v4/job_service.search_jobs_for_alert.js @@ -57,7 +57,7 @@ function main(parent, requestMetadata) { * * `count(numeric_histogram_facet, list of buckets)`: Count the number of * matching entities within each bucket. * Data types: - * * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. + * * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/samples/generated/v4beta1/job_service.search_jobs.js b/packages/google-cloud-talent/samples/generated/v4beta1/job_service.search_jobs.js index 83a5a888203..e3a90cc1715 100644 --- a/packages/google-cloud-talent/samples/generated/v4beta1/job_service.search_jobs.js +++ b/packages/google-cloud-talent/samples/generated/v4beta1/job_service.search_jobs.js @@ -68,7 +68,7 @@ function main(parent, requestMetadata) { * * `count(numeric_histogram_facet, list of buckets)`: Count the number of * matching entities within each bucket. * Data types: - * * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. + * * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/samples/generated/v4beta1/job_service.search_jobs_for_alert.js b/packages/google-cloud-talent/samples/generated/v4beta1/job_service.search_jobs_for_alert.js index 79092740791..ec50f262029 100644 --- a/packages/google-cloud-talent/samples/generated/v4beta1/job_service.search_jobs_for_alert.js +++ b/packages/google-cloud-talent/samples/generated/v4beta1/job_service.search_jobs_for_alert.js @@ -68,7 +68,7 @@ function main(parent, requestMetadata) { * * `count(numeric_histogram_facet, list of buckets)`: Count the number of * matching entities within each bucket. * Data types: - * * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. + * * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/samples/generated/v4beta1/profile_service.search_profiles.js b/packages/google-cloud-talent/samples/generated/v4beta1/profile_service.search_profiles.js index e0e84a5d17f..1ca51f3310c 100644 --- a/packages/google-cloud-talent/samples/generated/v4beta1/profile_service.search_profiles.js +++ b/packages/google-cloud-talent/samples/generated/v4beta1/profile_service.search_profiles.js @@ -98,7 +98,7 @@ function main(parent, requestMetadata) { * The expression syntax looks like a function definition with parameters. * Function syntax: function_name(histogram_facet[, list of buckets]) * Data types: - * * Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. + * * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/src/v4/job_service_client.ts b/packages/google-cloud-talent/src/v4/job_service_client.ts index d94b223af39..6aa1529dacb 100644 --- a/packages/google-cloud-talent/src/v4/job_service_client.ts +++ b/packages/google-cloud-talent/src/v4/job_service_client.ts @@ -822,7 +822,7 @@ export class JobServiceClient { * * Data types: * - * * Histogram facet: facet names with format {@link a-zA-Z0-9_|a-zA-Z}+. + * * Histogram facet: facet names with format `{@link a-zA-Z0-9_|a-zA-Z}+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square @@ -1148,7 +1148,7 @@ export class JobServiceClient { * * Data types: * - * * Histogram facet: facet names with format {@link a-zA-Z0-9_|a-zA-Z}+. + * * Histogram facet: facet names with format `{@link a-zA-Z0-9_|a-zA-Z}+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/src/v4beta1/job_service_client.ts b/packages/google-cloud-talent/src/v4beta1/job_service_client.ts index 188b0924a19..e359afec201 100644 --- a/packages/google-cloud-talent/src/v4beta1/job_service_client.ts +++ b/packages/google-cloud-talent/src/v4beta1/job_service_client.ts @@ -954,7 +954,7 @@ export class JobServiceClient { * * Data types: * - * * Histogram facet: facet names with format {@link a-zA-Z0-9_|a-zA-Z}+. + * * Histogram facet: facet names with format `{@link a-zA-Z0-9_|a-zA-Z}+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square @@ -1276,7 +1276,7 @@ export class JobServiceClient { * * Data types: * - * * Histogram facet: facet names with format {@link a-zA-Z0-9_|a-zA-Z}+. + * * Histogram facet: facet names with format `{@link a-zA-Z0-9_|a-zA-Z}+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square diff --git a/packages/google-cloud-talent/src/v4beta1/profile_service_client.ts b/packages/google-cloud-talent/src/v4beta1/profile_service_client.ts index 5036d5e0ef5..231e2e2ae5c 100644 --- a/packages/google-cloud-talent/src/v4beta1/profile_service_client.ts +++ b/packages/google-cloud-talent/src/v4beta1/profile_service_client.ts @@ -833,7 +833,7 @@ export class ProfileServiceClient { * * Data types: * - * * Histogram facet: facet names with format {@link a-zA-Z0-9_|a-zA-Z}+. + * * Histogram facet: facet names with format `{@link a-zA-Z0-9_|a-zA-Z}+`. * * String: string like "any string with backslash escape for quote(\")." * * Number: whole number and floating point number like 10, -1 and -0.01. * * List: list of elements with comma(,) separator surrounded by square