From 3b29083a80dcc4bc26f0b0c56d25dc21fb301ee3 Mon Sep 17 00:00:00 2001 From: Lahiru Maramba Date: Thu, 5 May 2022 09:44:37 -0400 Subject: [PATCH] Fix markdown lists in reference docs --- src/eventarc/eventarc.ts | 9 ++++++--- src/functions/functions-api.ts | 1 + src/functions/functions.ts | 9 ++++++--- 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/src/eventarc/eventarc.ts b/src/eventarc/eventarc.ts index 363679a375..a1edc4a011 100644 --- a/src/eventarc/eventarc.ts +++ b/src/eventarc/eventarc.ts @@ -70,12 +70,15 @@ export class Eventarc { /** * Creates a reference to the Eventarc channel using the provided channel resource name. * The channel resource name can be either: - * * A fully qualified channel resource name: + * + * - A fully qualified channel resource name: * `projects/{project}/locations/{location}/channels/{channel-id}` - * * A partial resource name with location and channel ID, in which case + * + * - A partial resource name with location and channel ID, in which case * the runtime project ID of the function is used: * `locations/{location}/channels/{channel-id}` - * * A partial channel ID, in which case the runtime project ID of the + * + * - A partial channel ID, in which case the runtime project ID of the * function and `us-central1` as location is used: * `{channel-id}` * diff --git a/src/functions/functions-api.ts b/src/functions/functions-api.ts index 1383495aa7..60351211e9 100644 --- a/src/functions/functions-api.ts +++ b/src/functions/functions-api.ts @@ -42,6 +42,7 @@ export interface AbsoluteDelivery { /** * Type representing delivery schedule options. + * `DeliverySchedule` is a union type of {@link DelayDelivery} and {@link AbsoluteDelivery} types. */ export type DeliverySchedule = DelayDelivery | AbsoluteDelivery diff --git a/src/functions/functions.ts b/src/functions/functions.ts index 648f593297..08a38ab7ac 100644 --- a/src/functions/functions.ts +++ b/src/functions/functions.ts @@ -39,12 +39,15 @@ export class Functions { /** * Creates a reference to a {@link TaskQueue} for a given function name. * The function name can be either: - * * A fully qualified function resource name: + * + * 1) A fully qualified function resource name: * `projects/{project}/locations/{location}/functions/{functionName}` - * * A partial resource name with location and function name, in which case + * + * 2) A partial resource name with location and function name, in which case * the runtime project ID is used: * `locations/{location}/functions/{functionName}` - * * A partial function name, in which case the runtime project ID and the default location, + * + * 3) A partial function name, in which case the runtime project ID and the default location, * `us-central1`, is used: * `{functionName}` *