-
Notifications
You must be signed in to change notification settings - Fork 325
style: Add format all option #344
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
Conversation
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.
Summary of Changes
Hello @holtskinner, 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 introduces significant improvements to the project's code formatting workflow by enhancing the format.sh script with new options for comprehensive and flexible code formatting. Alongside these functional updates, it incorporates various stylistic and best-practice adjustments across the codebase, ensuring greater consistency, readability, and adherence to modern Python standards.
Highlights
- Code Formatting Script Enhancement: The
format.shscript has been significantly enhanced to include new command-line options. A--allflag now allows users to format every Python file in the repository, rather than just those changed in the current Git diff. Additionally, an--unsafe-fixesflag has been added, which is passed directly to Ruff for more aggressive automatic code corrections. - Linter Configuration and Style Alignment: Updates to the
.ruff.tomlconfiguration remove theN815(camelCase variable name) ignore rule fortypes.py, indicating a stricter adherence to naming conventions. Severalnoqacomments related toPLC0415(lazy import) have also been removed, suggesting that these imports are now handled appropriately by the linter or are no longer considered problematic. - Python Best Practices and Consistency: Across multiple test files, the naming convention for
pushNotificationConfighas been standardized topush_notification_configto align with Python'ssnake_caseconvention. Furthermore,assert result == Nonechecks have been updated to the more Pythonicassert result is None, andisinstancechecks now utilize the modern|(union) operator for type comparisons (e.g.,ConnectionResetError | RuntimeError), improving readability and adhering to contemporary Python syntax.
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 or fill out our survey to provide feedback.
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
-
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. ↩
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
The code changes primarily focus on formatting and minor code improvements across several files. The addition of the --all option to the formatting script is a notable enhancement.
No description provided.