-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs: update the list of available APIs #15552
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
docs: update the list of available APIs #15552
Conversation
Summary of ChangesHello @yoshi-code-bot, 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 updates the project's Highlights
Changelog
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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 updates the README.rst file to include several new APIs and helper libraries in the list of available packages. The changes are mostly correct, but there are a few places where the new entries are not added in alphabetical order, which impacts the maintainability of this documentation file. I've left comments on the specific lines where the ordering should be corrected.
| * - `API Registry API <https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-apiregistry>`_ | ||
| - preview | ||
| - |PyPI-google-cloud-apiregistry| | ||
| - `API Issues <https://issuetracker.google.com/issues?q=componentid:1979613>`_ | ||
| - `File an API Issue <https://issuetracker.google.com/issues/new?component=1979613&template=2231768>`_ | ||
| - `Client Library Issues <https://github.com/googleapis/google-cloud-python/issues>`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new entry for API Registry API is not in the correct alphabetical position. It is placed before Access Context Manager, but it should come after it to maintain the alphabetical sorting of the library list.
References
- Lists, such as this list of libraries, should be kept in alphabetical order to improve readability and maintainability. This is analogous to the general rule about programmatically sorting dictionary keys.
| .. |PyPI-google-cloud-apiregistry| image:: https://img.shields.io/pypi/v/google-cloud-apiregistry.svg | ||
| :target: https://pypi.org/project/google-cloud-apiregistry |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new badge definition for PyPI-google-cloud-apiregistry is not in the correct global alphabetical position. For instance, it's placed before PyPI-google-cloud-access-context-manager, which should appear much earlier in the list. To improve maintainability, please place new entries in their correct alphabetical position.
References
- Lists, such as this list of badge definitions, should be kept in alphabetical order to improve readability and maintainability. This is analogous to the general rule about programmatically sorting dictionary keys.
| .. |PyPI-google-cloud-testutils| image:: https://img.shields.io/pypi/v/google-cloud-testutils.svg | ||
| :target: https://pypi.org/project/google-cloud-testutils |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new badge definition for PyPI-google-cloud-testutils is not in the correct alphabetical position. It is placed before PyPI-google-cloud-quotas, but should come after it. For better maintainability, this list of definitions should be kept in alphabetical order.
References
- Lists, such as this list of badge definitions, should be kept in alphabetical order to improve readability and maintainability. This is analogous to the general rule about programmatically sorting dictionary keys.
Update the list of available APIs in the README.