update: average issues per post calculation to handle zero issues case - #1042
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @SteveJonesDev, 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 refines the display logic for the 'average issues per post' metric in the admin statistics page. The primary goal is to provide more accurate and intuitive reporting, particularly for cases where no issues are present, by explicitly showing '0' instead of a calculated average that might be misleading.
Highlights
- Average Calculation Logic: Modified the calculation for
avg_issues_per_postto explicitly set it to0when there are no warnings or errors, improving clarity for zero-issue scenarios. - Display Formatting: Ensured that the average issues per post is displayed as
0when no issues exist, and continues to display as"< 1"when the calculated average is less than one but greater than zero.
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 is currently in preview and 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 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. ↩
WalkthroughThe logic for formatting the "average issues per post" in the summary data has been updated. Now, if the average is exactly zero, it remains as 0; if it is greater than zero but less than 1, it displays as "< 1". This clarifies the distinction between zero and very small averages. Changes
Suggested reviewers
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 phpcs (3.7.2)admin/class-scans-stats.php📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Code Review
This pull request aims to clarify the logic for calculating the average issues per post, especially for the zero-issue case. The change correctly handles all scenarios, but introduces some redundant code. My review provides a suggestion to simplify the logic, making it more concise and maintainable while preserving the intended clarity.
pattonwebz
left a comment
pattonwebz
left a comment
There was a problem hiding this comment.
I tested this and see why this change works. The old code was checking for exactly 0 integer but the return of round is a float so the check would need to be 0.0 or be loosely typed to get the same result.
2 participants
This pull request introduces a small but meaningful change to improve the clarity of how average issues per post are displayed in the
admin/class-scans-stats.phpfile. Specifically, it ensures that when there are no issues at all, the average is explicitly shown as0, and when the average is less than1, it is displayed as"< 1".Key change:
function ( $item )to handle cases where there are no issues (warningsanderrorsboth equal0) by explicitly settingavg_issues_per_postto0. This improves the accuracy and readability of the displayed data.Fixes: https://github.com/equalizedigital/accessibility-checker-pro/issues/333
Summary by CodeRabbit