Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix markdown lists in reference docs #1687

Merged
merged 1 commit into from
May 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/eventarc/eventarc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}`
*
Expand Down
1 change: 1 addition & 0 deletions src/functions/functions-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 6 additions & 3 deletions src/functions/functions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}`
*
Expand Down