Skip to content

Update view of Parameters list in v1 #1724

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

Conversation

IrynaSabinina
Copy link

styled as a list of parameters (bullet points) instead of raw inline text.

Description

Code sample

styled as a list of parameters (bullet points) instead of raw inline text.
Copy link

google-cla bot commented Aug 21, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @IrynaSabinina, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the readability of the documentation for the runtimeOptions parameter within the function-builder.ts file. The change involves reformatting the parameter list from a dense, numbered inline text to a more visually distinct bulleted list, making it easier for developers to quickly grasp the available options and their descriptions.

Highlights

  • Documentation Formatting: Updated the JSDoc for the runtimeOptions parameter in src/v1/function-builder.ts to display its properties as a bulleted list instead of a numbered inline list. This improves readability.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request improves the documentation for the runWith function by using a bulleted list for parameters. I've provided a suggestion to make the formatting more compact and use standard list markers, which will improve readability. For consistency, you might also want to apply similar formatting to the runWith method within the FunctionBuilder class.

Comment on lines +268 to 287
*
*
* • `memory`: amount of memory to allocate to the function, possible values
* are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'.
* 2. `timeoutSeconds`: timeout for the function in seconds, possible values are
*
* • `timeoutSeconds`: timeout for the function in seconds, possible values are
* 0 to 540.
* 3. `failurePolicy`: failure policy of the function, with boolean `true` being
*
* • `failurePolicy`: failure policy of the function, with boolean `true` being
* equivalent to providing an empty retry object.
* 4. `vpcConnector`: id of a VPC connector in same project and region.
* 5. `vpcConnectorEgressSettings`: when a vpcConnector is set, control which
*
* • `vpcConnector`: id of a VPC connector in same project and region.
*
* • `vpcConnectorEgressSettings`: when a vpcConnector is set, control which
* egress traffic is sent through the vpcConnector.
* 6. `serviceAccount`: Specific service account for the function.
* 7. `ingressSettings`: ingress settings for the function, which control where a HTTPS
*
* • `serviceAccount`: Specific service account for the function.
*
* • `ingressSettings`: ingress settings for the function, which control where a HTTPS
* function can be called from.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While using a bulleted list improves readability, the current formatting has too much vertical spacing, making the documentation unnecessarily long. I suggest a more compact version using a standard markdown list marker (- instead of ), which is more conventional for JSDoc.

Suggested change
*
*
* `memory`: amount of memory to allocate to the function, possible values
* are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'.
* 2. `timeoutSeconds`: timeout for the function in seconds, possible values are
*
* `timeoutSeconds`: timeout for the function in seconds, possible values are
* 0 to 540.
* 3. `failurePolicy`: failure policy of the function, with boolean `true` being
*
* `failurePolicy`: failure policy of the function, with boolean `true` being
* equivalent to providing an empty retry object.
* 4. `vpcConnector`: id of a VPC connector in same project and region.
* 5. `vpcConnectorEgressSettings`: when a vpcConnector is set, control which
*
* `vpcConnector`: id of a VPC connector in same project and region.
*
* `vpcConnectorEgressSettings`: when a vpcConnector is set, control which
* egress traffic is sent through the vpcConnector.
* 6. `serviceAccount`: Specific service account for the function.
* 7. `ingressSettings`: ingress settings for the function, which control where a HTTPS
*
* `serviceAccount`: Specific service account for the function.
*
* `ingressSettings`: ingress settings for the function, which control where a HTTPS
* function can be called from.
*
* - `memory`: amount of memory to allocate to the function, possible values
* are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'.
* - `timeoutSeconds`: timeout for the function in seconds, possible values are
* 0 to 540.
* - `failurePolicy`: failure policy of the function, with boolean `true` being
* equivalent to providing an empty retry object.
* - `vpcConnector`: id of a VPC connector in same project and region.
* - `vpcConnectorEgressSettings`: when a vpcConnector is set, control which
* egress traffic is sent through the vpcConnector.
* - `serviceAccount`: Specific service account for the function.
* - `ingressSettings`: ingress settings for the function, which control where a HTTPS
* function can be called from.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is Markdown-style documentation, after converting it to HTML and viewing it in the browser, all the different items appear as a single paragraph, but what we actually need is a properly formatted list. For this we need to add blank lines between them.

@IrynaSabinina IrynaSabinina requested a review from kaibolay August 21, 2025 14:41
@kaibolay kaibolay enabled auto-merge August 21, 2025 14:43
auto-merge was automatically disabled August 22, 2025 15:27

Pull request was closed

@github-project-automation github-project-automation bot moved this from Approved [PR] to Done in [Cloud] Extensions + Functions Aug 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants