docs(ai): add missing JSDoc descriptions for AI provider tables and t… - #1951
docs(ai): add missing JSDoc descriptions for AI provider tables and t…#1951shettyvarun268 wants to merge 4 commits into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds JSDoc documentation to various exported types, interfaces, and constants in the AI provider module to improve API clarity. The review feedback suggests two improvements to the added documentation: clarifying that BlockingFunction is a Cloud Function that handles AI blocking events rather than being returned by handlers, and correcting the description of contents in GenerateContentRequest to specify that it represents an array of conversation turns rather than individual content parts.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request adds JSDoc documentation comments to various exported types, interfaces, constants, and properties within the AI provider module, specifically in src/v2/providers/ai/index.ts and src/v2/providers/ai/types/gemini/v1beta/index.ts. These additions improve code readability and API documentation. There are no review comments, so I have no feedback to provide.
| */ | ||
| export interface AfterGenerateContentData<API extends string = string> | ||
| extends BeforeGenerateContentData<API> { | ||
| /** The model's response payload (available for afterGenerateContent only). */ |
There was a problem hiding this comment.
same as my comment above... we don't need this here in the source code (and resulting ref docs)
egilmorez
left a comment
egilmorez
left a comment
There was a problem hiding this comment.
A few things to look at, thanks Varun!
The main thing I see is basically this stuff: https://docs.google.com/presentation/d/1Ezb4sp4XD6ItHISccnME-EVH_oJj59R5Naq0IskLrAo/edit?slide=id.g1cd7eabb964_0_10#slide=id.g1cd7eabb964_0_10
| */ | ||
| export interface AfterGenerateContentData<API extends string = string> | ||
| extends BeforeGenerateContentData<API> { | ||
| /** The model's response payload (available for afterGenerateContent only). */ |
There was a problem hiding this comment.
same as my comment above... we don't need this here in the source code (and resulting ref docs)
5 participants
Description
Adds missing JSDoc descriptions for exported interfaces, variables, type aliases, and properties in
firebase-functions/v2/aiso that all reference overview tables are populated with descriptions.Release notes
relnote: none