docs: private API guidance and formatting fixes

[raushan728]

• Added static_discovery=False tip for private APIs in README.md
• Minor whitespace and formatting cleanup

[gemini-code-assist]

Summary of Changes

Hello @raushan728, 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 focuses on improving the clarity and correctness of the project's documentation. It resolves a minor syntax issue in the upgrade guide and introduces essential guidance for developers working with private APIs, ensuring a smoother experience for users of the library. The changes aim to make the documentation more accurate and helpful without altering any core functionality.

Highlights

• Documentation Fix: Corrected a syntax error in UPGRADING.md by adding missing quotes in a code example.
• Private API Guidance: Added a new section to README.md providing clear instructions and a code example for using private APIs with static_discovery=False.
• Readability Improvements: Applied minor formatting adjustments across both README.md and UPGRADING.md to enhance overall readability, including consistent spacing and heading styles.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 improves the documentation by fixing some formatting issues, correcting a syntax error in a code example, and adding a helpful note about using private APIs. The changes make the documentation clearer and more accurate. I have one suggestion to improve the clarity of an example in UPGRADING.md to avoid potential user confusion.

[ZLeventer]

The static_discovery=False tip for private APIs is a useful addition — this trips up developers who have a private/internal API and can't figure out why build() fails with a "service not found" error when the API isn't in the bundled discovery documents.

The rest of the changes (markdown formatting fixes, whitespace normalization, list indentation) are cosmetic but improve readability. The syntax error fix in the original README (trailing whitespace in code blocks) is minor but correct.

One thing: the PR title says "fix syntax error" but the real value-add is the private API documentation section. Might be worth updating the title/description to highlight that — it'll make it easier for maintainers to prioritize.

[raushan728]

The static_discovery=False tip for private APIs is a useful addition — this trips up developers who have a private/internal API and can't figure out why build() fails with a "service not found" error when the API isn't in the bundled discovery documents.

The rest of the changes (markdown formatting fixes, whitespace normalization, list indentation) are cosmetic but improve readability. The syntax error fix in the original README (trailing whitespace in code blocks) is minor but correct.

One thing: the PR title says "fix syntax error" but the real value-add is the private API documentation section. Might be worth updating the title/description to highlight that — it'll make it easier for maintainers to prioritize.

Thanks for the feedback updated the PR title and desc to highlight the private API guidance as the main change