Skip to content

Conversation

@baxelrod-bdai
Copy link
Contributor

The documentation for the whl_patches argument of whl_library contained an error. I fixed it and also elaborated the text in places that tripped me up.

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 @baxelrod-bdai, 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 enhancing the clarity and accuracy of the whl_library rule's documentation. It addresses specific areas that were identified as potentially confusing or incorrect, aiming to provide users with more precise guidance for configuring wheel dependencies and applying patches.

Highlights

  • dep_template documentation: Added a clear example to the dep_template argument documentation within whl_library to illustrate its usage with Python package repositories.
  • whl_patches documentation: Corrected and significantly expanded the documentation for the whl_patches argument, including a detailed code example and clarification on how patches are applied within the wheel's scope.
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 whl_library, fixing an error in the whl_patches attribute documentation and adding clarifying examples for both whl_patches and dep_template. The changes make the documentation more helpful for users. I've found one issue with the new example for dep_template where it's inconsistent with the attribute's description and could lead to errors in practice. My detailed comment explains the issue.

Comment on lines +581 to +582
For example if your whl depends on `numpy` and your Python package repo is named
`pip` so that you would normally do `@pip//numpy`, then this should be: `@pip//{name}`.
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This example is helpful for understanding the intent, but the suggested template @pip//{name} is inconsistent with the documentation above which states that the {target} token is also available. More importantly, this template will cause a failure when whl_library tries to load config.bzl from the repository. The implementation formats the template with target="config.bzl" and name="", which with the suggested template results in an invalid label @pip// for a load statement.

This indicates a potential issue in how dep_template is handled. To make the documentation correct and avoid confusing users, perhaps the example could be clarified that it's a simplified case and may not work universally. A more robust template would need to handle the {target} token, for instance: @pip//:{target}.

@rickeylev rickeylev enabled auto-merge September 11, 2025 19:50
@rickeylev
Copy link
Collaborator

Thanks for the doc fix!

@rickeylev rickeylev added this pull request to the merge queue Sep 11, 2025
Merged via the queue into bazel-contrib:main with commit 029a4dc Sep 11, 2025
3 checks passed
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