Skip to content

fix: [Many APIs] changing format of the jsdoc links #3990

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.

Sign up for GitHub

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

Merged
sofisl merged 9 commits into from
Feb 15, 2023
Merged

fix: [Many APIs] changing format of the jsdoc links #3990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4deb664
docs: changing format of the jsdoc links
gcf-owl-bot[bot] Feb 14, 2023
01ac7a4
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 14, 2023
f36ec58
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 14, 2023
e3bf2ab
Update index.ts
sofisl Feb 14, 2023
f7103df
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 14, 2023
79294b1
Merge branch 'main' into owl-bot-copy-a6070ab2264356e8f296
sofisl Feb 14, 2023
b986f52
Merge branch 'main' into owl-bot-copy-a6070ab2264356e8f296
sofisl Feb 14, 2023
55a3079
Update package.json
sofisl Feb 14, 2023
b176944
Merge branch 'main' into owl-bot-copy-a6070ab2264356e8f296
gcf-merge-on-green[bot] Feb 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 29 additions & 31 deletions packages/google-cloud-tpu/src/v1/tpu_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Node]{@link google.cloud.tpu.v1.Node}.
* The first element of the array is an object representing {@link google.cloud.tpu.v1.Node | Node}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
Expand Down Expand Up @@ -567,7 +567,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [TensorFlowVersion]{@link google.cloud.tpu.v1.TensorFlowVersion}.
* The first element of the array is an object representing {@link google.cloud.tpu.v1.TensorFlowVersion | TensorFlowVersion}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
Expand Down Expand Up @@ -658,7 +658,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [AcceleratorType]{@link google.cloud.tpu.v1.AcceleratorType}.
* The first element of the array is an object representing {@link google.cloud.tpu.v1.AcceleratorType | AcceleratorType}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
Expand Down Expand Up @@ -1444,7 +1444,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [Node]{@link google.cloud.tpu.v1.Node}.
* The first element of the array is Array of {@link google.cloud.tpu.v1.Node | Node}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
Expand Down Expand Up @@ -1534,7 +1534,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing [Node]{@link google.cloud.tpu.v1.Node} on 'data' event.
* An object stream which emits an object representing {@link google.cloud.tpu.v1.Node | Node} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listNodesAsync()`
Expand Down Expand Up @@ -1582,7 +1582,7 @@ export class TpuClient {
* @returns {Object}
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
* When you iterate the returned iterable, each element will be an object representing
* [Node]{@link google.cloud.tpu.v1.Node}. The API will be called under the hood as needed, once per the page,
* {@link google.cloud.tpu.v1.Node | Node}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
Expand Down Expand Up @@ -1629,7 +1629,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [TensorFlowVersion]{@link google.cloud.tpu.v1.TensorFlowVersion}.
* The first element of the array is Array of {@link google.cloud.tpu.v1.TensorFlowVersion | TensorFlowVersion}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
Expand Down Expand Up @@ -1735,7 +1735,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing [TensorFlowVersion]{@link google.cloud.tpu.v1.TensorFlowVersion} on 'data' event.
* An object stream which emits an object representing {@link google.cloud.tpu.v1.TensorFlowVersion | TensorFlowVersion} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listTensorFlowVersionsAsync()`
Expand Down Expand Up @@ -1787,7 +1787,7 @@ export class TpuClient {
* @returns {Object}
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
* When you iterate the returned iterable, each element will be an object representing
* [TensorFlowVersion]{@link google.cloud.tpu.v1.TensorFlowVersion}. The API will be called under the hood as needed, once per the page,
* {@link google.cloud.tpu.v1.TensorFlowVersion | TensorFlowVersion}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
Expand Down Expand Up @@ -1834,7 +1834,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [AcceleratorType]{@link google.cloud.tpu.v1.AcceleratorType}.
* The first element of the array is Array of {@link google.cloud.tpu.v1.AcceleratorType | AcceleratorType}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
Expand Down Expand Up @@ -1936,7 +1936,7 @@ export class TpuClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing [AcceleratorType]{@link google.cloud.tpu.v1.AcceleratorType} on 'data' event.
* An object stream which emits an object representing {@link google.cloud.tpu.v1.AcceleratorType | AcceleratorType} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listAcceleratorTypesAsync()`
Expand Down Expand Up @@ -1988,7 +1988,7 @@ export class TpuClient {
* @returns {Object}
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
* When you iterate the returned iterable, each element will be an object representing
* [AcceleratorType]{@link google.cloud.tpu.v1.AcceleratorType}. The API will be called under the hood as needed, once per the page,
* {@link google.cloud.tpu.v1.AcceleratorType | AcceleratorType}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
Expand Down Expand Up @@ -2025,9 +2025,9 @@ export class TpuClient {
* @param {string} request.name
* Resource name for the location.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Location]{@link google.cloud.location.Location}.
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
Expand Down Expand Up @@ -2077,7 +2077,7 @@ export class TpuClient {
* @returns {Object}
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
* When you iterate the returned iterable, each element will be an object representing
* [Location]{@link google.cloud.location.Location}. The API will be called under the hood as needed, once per the page,
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
Expand Down Expand Up @@ -2106,20 +2106,18 @@ export class TpuClient {
* @param {string} request.name - The name of the operation resource.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* details.
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback
* The function which will be called with the result of the API call.
*
* The second parameter to the callback is an object representing
* [google.longrunning.Operation]{@link
* external:"google.longrunning.Operation"}.
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* [google.longrunning.Operation]{@link
* external:"google.longrunning.Operation"}. The promise has a method named
* "cancel" which cancels the ongoing API call.
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*
* @example
* ```
Expand Down Expand Up @@ -2163,11 +2161,11 @@ export class TpuClient {
* resources in a page.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*
* @example
* ```
Expand Down Expand Up @@ -2198,8 +2196,8 @@ export class TpuClient {
* @param {string} request.name - The name of the operation resource to be cancelled.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
Expand Down Expand Up @@ -2241,9 +2239,9 @@ export class TpuClient {
* @param {string} request.name - The name of the operation resource to be deleted.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* details.
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
Expand Down
Loading
⚡