Skip to content

Commit 3b29083

Browse files
committed
Fix markdown lists in reference docs
1 parent 2a76539 commit 3b29083

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

src/eventarc/eventarc.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,15 @@ export class Eventarc {
7070
/**
7171
* Creates a reference to the Eventarc channel using the provided channel resource name.
7272
* The channel resource name can be either:
73-
* * A fully qualified channel resource name:
73+
*
74+
* - A fully qualified channel resource name:
7475
* `projects/{project}/locations/{location}/channels/{channel-id}`
75-
* * A partial resource name with location and channel ID, in which case
76+
*
77+
* - A partial resource name with location and channel ID, in which case
7678
* the runtime project ID of the function is used:
7779
* `locations/{location}/channels/{channel-id}`
78-
* * A partial channel ID, in which case the runtime project ID of the
80+
*
81+
* - A partial channel ID, in which case the runtime project ID of the
7982
* function and `us-central1` as location is used:
8083
* `{channel-id}`
8184
*

src/functions/functions-api.ts

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export interface AbsoluteDelivery {
4242

4343
/**
4444
* Type representing delivery schedule options.
45+
* `DeliverySchedule` is a union type of {@link DelayDelivery} and {@link AbsoluteDelivery} types.
4546
*/
4647
export type DeliverySchedule = DelayDelivery | AbsoluteDelivery
4748

src/functions/functions.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,15 @@ export class Functions {
3939
/**
4040
* Creates a reference to a {@link TaskQueue} for a given function name.
4141
* The function name can be either:
42-
* * A fully qualified function resource name:
42+
*
43+
* 1) A fully qualified function resource name:
4344
* `projects/{project}/locations/{location}/functions/{functionName}`
44-
* * A partial resource name with location and function name, in which case
45+
*
46+
* 2) A partial resource name with location and function name, in which case
4547
* the runtime project ID is used:
4648
* `locations/{location}/functions/{functionName}`
47-
* * A partial function name, in which case the runtime project ID and the default location,
49+
*
50+
* 3) A partial function name, in which case the runtime project ID and the default location,
4851
* `us-central1`, is used:
4952
* `{functionName}`
5053
*

0 commit comments

Comments
 (0)