Fix the documentation to use $GIT_EDITOR instead of $EDITOR #627
Conversation
Current Aviator status
This PR was merged using Aviator.
See the real-time status of this PR on the
Aviator webapp.
Use the Aviator Chrome Extension
to see the status of your PR within GitHub.
|
✅ FlexReview StatusCommon Owner:
Review SLO: |
Summary of ChangesHello @draftcode, 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 rectifies an inaccuracy in the project's documentation by replacing instances of the generic 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
|
There was a problem hiding this comment.
Code Review
This pull request correctly updates the documentation to reference $GIT_EDITOR instead of $EDITOR. The change is an improvement in accuracy. I've verified this against the implementation, which uses git var GIT_EDITOR to determine the editor. I have a couple of minor suggestions to further improve the clarity and precision of the documentation, but overall this is a good change.
|
|
||
| `--edit` | ||
| : When amending a commit, open the default git `$EDITOR` for modifying the | ||
| : When amending a commit, open the default `$GIT_EDITOR` for modifying the |
There was a problem hiding this comment.
While using $GIT_EDITOR is more accurate than $EDITOR, it's still a bit of a simplification. The tool uses git var GIT_EDITOR which resolves the editor through Git's whole lookup chain (the $GIT_EDITOR environment variable, core.editor config, $VISUAL, and then $EDITOR). To be more precise and helpful to the user, I'd suggest phrasing this more generally to refer to the 'default Git editor'.
| : When amending a commit, open the default `$GIT_EDITOR` for modifying the | |
| : When amending a commit, open the default Git editor for modifying the |
| title and body are not provided, `$GIT_EDITOR` pops up and you are asked to | ||
| provide them. |
There was a problem hiding this comment.
Similar to my other comment, while $GIT_EDITOR is an improvement over $EDITOR, it's more accurate to refer to it as the 'default Git editor' since av uses git var GIT_EDITOR to resolve it. This also makes the language a bit more formal and descriptive than 'pops up'.
| title and body are not provided, `$GIT_EDITOR` pops up and you are asked to | |
| provide them. | |
| title and body are not provided, the default Git editor is opened to prompt for | |
| them. |
Fixes #617