-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Improve linkage check script documentation for git references #36925
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
Improve linkage check script documentation for git references #36925
Conversation
The usage documentation previously showed 'origin/master' as an example, which incorrectly suggested that users must have a remote called 'origin'. The script actually accepts any valid git reference. This change clarifies the documentation by: - Using generic '<baseline ref>' placeholder instead of 'origin/master' - Adding examples of valid git references (remote branches, local branches, commit SHAs, and tags) Fixes apache#20650
Summary of ChangesHello @zhan7236, 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 improves the documentation for the Highlights
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
|
|
Assigning reviewers: R: @chamikaramj for label java. Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
|
Reminder, please take a look at this pr: @chamikaramj @liferoad |
|
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment R: @kennknowles for label java. Available commands:
|
kennknowles
left a comment
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.
LGTM. In fact, I don't have any remote named origin because I like more specific names, so I agree very much :-)
The usage documentation in
beam-linkage-check.shshowedorigin/masteras an example, which incorrectly suggested that users must have a remote called "origin". The script actually accepts any valid git reference.Changes:
<baseline ref>placeholder instead oforigin/masterorigin/master,upstream/mainmaster,my-feature-branchabc123defv2.50.0Fixes #20650
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.