Skip to content

Commit c66445c

Browse files
Fix doc comments (#8234)
* fix doc comments * fix one more comment * Update docs-devsite/vertexai-preview.md Co-authored-by: rachelsaunders <[email protected]> --------- Co-authored-by: rachelsaunders <[email protected]>
1 parent d79a131 commit c66445c

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

docs-devsite/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ https://github.com/firebase/firebase-js-sdk
2727
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
2828
| [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
2929
| [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
30-
| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Firebase Vertex Web SDK. |
30+
| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Vertex AI For Firebase Web SDK. |
3131

docs-devsite/vertexai-preview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# vertexai-preview package
13-
The Firebase Vertex Web SDK.
13+
The Vertex AI For Firebase Web SDK.
1414

1515
## Functions
1616

1717
| Function | Description |
1818
| --- | --- |
1919
| <b>function(app, ...)</b> |
20-
| [getVertexAI(app, options)](./vertexai-preview.md#getvertexai_04094cf) | Returns an [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) instance for the given app. |
20+
| [getVertexAI(app, options)](./vertexai-preview.md#getvertexai_04094cf) | Returns a [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) instance for the given app. |
2121
| <b>function(vertexAI, ...)</b> |
2222
| [getGenerativeModel(vertexAI, modelParams, requestOptions)](./vertexai-preview.md#getgenerativemodel_e3037c9) | Returns a [GenerativeModel](./vertexai-preview.generativemodel.md#generativemodel_class) class with methods for inference and other functionality. |
2323

@@ -87,7 +87,7 @@ The Firebase Vertex Web SDK.
8787
| [ToolConfig](./vertexai-preview.toolconfig.md#toolconfig_interface) | Tool config. This config is shared for all tools provided in the request. |
8888
| [UsageMetadata](./vertexai-preview.usagemetadata.md#usagemetadata_interface) | Usage metadata about a [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->. |
8989
| [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) | An instance of the Vertex AI for Firebase SDK. |
90-
| [VertexAIOptions](./vertexai-preview.vertexaioptions.md#vertexaioptions_interface) | Options when initializing the Firebase Vertex AI SDK. |
90+
| [VertexAIOptions](./vertexai-preview.vertexaioptions.md#vertexaioptions_interface) | Options when initializing the Vertex AI for Firebase SDK. |
9191
| [VideoMetadata](./vertexai-preview.videometadata.md#videometadata_interface) | Describes the input video content. |
9292
| [WebAttribution](./vertexai-preview.webattribution.md#webattribution_interface) | |
9393

@@ -109,7 +109,7 @@ The Firebase Vertex Web SDK.
109109

110110
### getVertexAI(app, options) {:#getvertexai_04094cf}
111111

112-
Returns an [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) instance for the given app.
112+
Returns a [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) instance for the given app.
113113

114114
<b>Signature:</b>
115115

docs-devsite/vertexai-preview.vertexaioptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# VertexAIOptions interface
13-
Options when initializing the Firebase Vertex AI SDK.
13+
Options when initializing the Vertex AI for Firebase SDK.
1414

1515
<b>Signature:</b>
1616

packages/vertexai/src/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ declare module '@firebase/component' {
3636
}
3737

3838
/**
39-
* Returns an {@link VertexAI} instance for the given app.
39+
* Returns a {@link VertexAI} instance for the given app.
4040
*
4141
* @public
4242
*

packages/vertexai/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* The Firebase Vertex Web SDK.
2+
* The Vertex AI For Firebase Web SDK.
33
*
44
* @packageDocumentation
55
*/

packages/vertexai/src/public-types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface VertexAI {
3232
}
3333

3434
/**
35-
* Options when initializing the Firebase Vertex AI SDK.
35+
* Options when initializing the Vertex AI for Firebase SDK.
3636
* @public
3737
*/
3838
export interface VertexAIOptions {

0 commit comments

Comments
 (0)