[doc] specify help string by keyword in configs.

[jakevdp]

This will ensure the help strings appear in the rendered docs.

Before:

After:

[gemini-code-assist]

Summary of Changes

Hello @jakevdp, I'm Gemini Code Assist¹! 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 refines the definition of configuration flags within 'jax/_src/xla_bridge.py' by explicitly assigning help strings to the 'help' keyword argument. This change is crucial for ensuring that these descriptive strings are properly parsed and included in the generated documentation, thereby enhancing the clarity and completeness of the project's user-facing guides.

Highlights

• Documentation Consistency: Ensures that help strings for configuration flags are correctly recognized and rendered in documentation by explicitly using the 'help' keyword argument.
• Configuration Flag Definitions: Updates the definition of several 'config.string_flag' and 'config.int_flag' calls in 'jax/_src/xla_bridge.py' to conform to the expected format for documentation generation.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. ↩

[gemini-code-assist]

Code Review

This pull request updates several configuration flag definitions in jax/_src/xla_bridge.py to use a keyword argument for the help string. This is a good change for clarity and to support documentation generation. I've suggested a further improvement for consistency: using keyword arguments for name and default as well, to align with the style of other flag definitions in the same file.

[ZacCranko]

LGTM