fix(spp_graduation): add web_icon to Graduation menu#99
Conversation
…ting README diffs - Added web_icon attribute to Graduation root menu to display the existing openspp-graduation-menu-icons.png icon - Regenerated READMEs for spp_aggregation, spp_metrics_core, and spp_metrics_services to match updated DESCRIPTION.md content
Summary of ChangesHello, 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 addresses a user interface inconsistency by ensuring the Graduation menu displays its intended icon. Concurrently, it resolves several documentation discrepancies across core modules by updating their README files, which also rectifies pre-commit CI failures related to outdated documentation. Highlights
Changelog
Activity
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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly adds the web_icon to the Graduation menu as intended. It also includes updates to several README files. While most of the documentation changes are fine, the spp_aggregation/README.rst file contains a formatting error in the 'Key Models' table that breaks the reStructuredText syntax and will likely cause rendering issues. I've added a specific comment with details on how to address this.
| | `` | Abstract service: resolves | | ||
| | spp.aggregation.scope.resolver`` | scopes to registrant IDs | | ||
| +----------------------------------+----------------------------------+ | ||
| | ``spp. | Abstract service: dispatches | | ||
| | aggregation.statistic.registry`` | statistic computation | | ||
| +----------------------------------+----------------------------------+ |
There was a problem hiding this comment.
The Key Models table has formatting issues that will likely cause rendering problems. The backticks (``) for code formatting are split across lines for spp.aggregation.scope.resolver and `spp.aggregation.statistic.registry`, which is invalid reStructuredText syntax.
Since this file is auto-generated, the root cause is likely in the generator script. A proper fix would be to adjust the script to handle long model names correctly, either by widening the table column or by ensuring the content within the backticks is wrapped correctly. A simpler, immediate fix would be to remove the code formatting for these two long model names.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 19.0 #99 +/- ##
=======================================
Coverage 70.39% 70.39%
=======================================
Files 674 674
Lines 37005 37005
=======================================
Hits 26051 26051
Misses 10954 10954
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Table column widths differ between macOS and Linux docutils rendering. Adjusted to match CI-generated output exactly.
…c, spp_statistic_studio These modules have DESCRIPTION.md files but their generated README.rst files were not committed, causing CI check-in step to fail.
2 participants
Why is this change needed?
The
openspp-graduation-menu-icons.pngfile existed inspp_graduation/static/description/but was not referenced by the Graduation root menu, so the menu had no icon.Also fixes pre-existing README diffs for
spp_aggregation,spp_metrics_core, andspp_metrics_servicesthat were causing pre-commit CI failures on all PRs.How was the change implemented?
web_iconattribute to themenu_graduation_rootmenuitemNew unit tests
Unit tests executed by the author
How to test manually
spp_graduationRelated links