GCI35 : Check an existing rule in Credengo Python that had been implemented but not previously validated. - #456
Open
aaudric wants to merge 2 commits into
Open
GCI35 : Check an existing rule in Credengo Python that had been implemented but not previously validated.#456aaudric wants to merge 2 commits into
aaudric wants to merge 2 commits into
Conversation
…ut not previously validated.
github-project-automation
Bot
moved this to Backlog
in Hackathon Kanban - RULES-SPECIFICATIONS
Contributor
|
@aaudric : Could you update the |
MP-Aubay
moved this from Backlog
to Ready To Review
in Hackathon Kanban - RULES-SPECIFICATIONS
Author
|
@MP-Aubay : It's done |
dedece35
added
🗒️ documentation
dedece35
moved this from Ready To Review
to Review in progress
in Hackathon Kanban - RULES-SPECIFICATIONS
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Python specification for rule GCI35 to include a concrete “experimental verification” section intended to validate the rule’s impact (runtime and CO₂ emissions), and records the change in the project changelog.
Changes:
- Updated the non-compliant/compliant code examples to use
with open(...)and anos.path.isfile(...)guard. - Added an “Experimental Verification” section with benchmark code, reported results, and plots.
- Added a corresponding entry to
CHANGELOG.md.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
src/main/rules/GCI35/python/GCI35.asciidoc |
Expands the rule documentation with updated examples plus benchmarking/verification content and plots. |
CHANGELOG.md |
Adds an entry documenting the GCI35 documentation/validation update. |
Comments suppressed due to low confidence (6)
src/main/rules/GCI35/python/GCI35.asciidoc:50
- Grammar in this comment is incorrect ("function who use", "no compliant_solution"). This is user-facing documentation; please correct the wording.
#function who use the no compliant_solution
src/main/rules/GCI35/python/GCI35.asciidoc:64
- Grammar in this comment is incorrect ("function who use"). Please correct the wording for readability.
#function who use the compliant solution
src/main/rules/GCI35/python/GCI35.asciidoc:146
- There are multiple spelling/wording issues in this plot section ("en kg", and inconsistent CO₂/CO2). Adjusting the axis label improves clarity.
plt.xlabel("Iterations")
plt.ylabel("CO2 emissions en kg")
plt.legend()
src/main/rules/GCI35/python/GCI35.asciidoc:151
- Spelling in the image caption/alt text is incorrect ("splutions", "for the both"). Please correct it for readability and professionalism.
image::../python/comparison_plots.png[Metrics for the both splutions]
src/main/rules/GCI35/python/GCI35.asciidoc:104
- The “Initial Results” text contains spelling issues ("Emisssion") and inconsistent phrasing. Since these values are presented as a reference, fix the wording for clarity.
Emisssion no compliant solution : 2.76e-05
Time for no compliant solution : 39.21
Emisssion compliant solution : 1.86e-05
Time for compliant solution : 26.35
src/main/rules/GCI35/python/GCI35.asciidoc:46
- Section title uses inconsistent spelling (“Non compliant”). Elsewhere in the document you use “Compliant”; for consistency and standard English usage, prefer “Non-compliant”.
=== Non compliant Implementation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| import os | ||
| import time | ||
|
|
||
| path = ('text.txt') # the famous file not founded |
Comment on lines
+108
to
+110
| * lower execution time | ||
| * lower CO₂ emissions | ||
| * reduced unnecessary resource consumption |
Member
|
Hi @aaudric , |
dedece35
requested changes
Jun 8, 2026
| import os | ||
| import time | ||
|
|
||
| path = ('text.txt') # the famous file not founded |
Comment on lines
+108
to
+110
| * lower execution time | ||
| * lower CO₂ emissions | ||
| * reduced unnecessary resource consumption |
| ### Added | ||
|
|
||
| - [#438](https://github.com/green-code-initiative/creedengo-rules-specifications/pull/438) Add rule GCI113 (Python): AI - Prefer XGBoost to RandomForest | ||
| - [#456](https://github.com/green-code-initiative/creedengo-rules-specifications/pull/456) Adding a check to a rule already implemented in Python |
Member
There was a problem hiding this comment.
please add the number of the rule
Contributor
|
This PR has been automatically marked as stale because it has no activity for 60 days. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.