Skip to content

Comments

docs(gazelle): Add versionadded details to some Gazelle directives.md#3624

Draft
dougthor42 wants to merge 2 commits intobazel-contrib:mainfrom
dougthor42:u/dthor/versionadded
Draft

docs(gazelle): Add versionadded details to some Gazelle directives.md#3624
dougthor42 wants to merge 2 commits intobazel-contrib:mainfrom
dougthor42:u/dthor/versionadded

Conversation

@dougthor42
Copy link
Collaborator

Also fixup CHANGELOG.md typo.

Wait for #3623

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @dougthor42, 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 primarily focuses on improving the accuracy and completeness of the project's documentation. It updates the Gazelle directives documentation by adding specific version information for various Python-related directives, making it easier for users to track feature availability. Additionally, a minor but important typo in the changelog was corrected to ensure consistency with the actual directive name.

Highlights

  • Documentation Enhancement: Added versionadded directives to the documentation for several Gazelle Python-related directives, providing clarity on when these features were introduced.
  • Changelog Correction: Fixed a typo in CHANGELOG.md, correcting the name of a Gazelle directive from python_generate_pyi_deps to python_generate_pyi_srcs.

🧠 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.

Changelog
  • CHANGELOG.md
    • Corrected a typo in the python_generate_pyi_deps directive name to python_generate_pyi_srcs.
  • gazelle/docs/directives.md
    • Added versionadded details for python_proto_naming_convention (v1.6.0).
    • Added versionadded details for python_default_visibility (v0.32.0).
    • Added versionadded details for python_visibility (v0.32.0).
    • Added versionadded details for python_test_file_pattern (v0.32.0).
    • Added versionadded details for python_label_convention (v0.34.0).
    • Added versionadded details for python_label_normalization (v0.34.0).
    • Added versionadded details for python_generate_pyi_deps (v1.6.0).
    • Added versionadded details for python_generate_pyi_srcs (v1.6.0).
    • Added versionadded details for python_generate_proto (v1.6.0).
    • Added versionadded details for python_resolve_sibling_imports (v1.6.0).
    • Added versionadded details for python_include_ancestor_conftest (v1.9.0).
Activity
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.

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 introduces documentation improvements for Gazelle directives and fixes a typo in the changelog. The versionadded directive has been added to several Gazelle directives in gazelle/docs/directives.md, providing clarity on when each feature was introduced. The formatting is consistent and the version information appears to be correct based on the provided changelog. Additionally, a typo in CHANGELOG.md has been corrected, changing python_generate_pyi_deps to python_generate_pyi_srcs to match the feature description. The changes are straightforward and look good.

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.

1 participant