refactor: remove redundant commented-out code #297
Conversation
This file contains 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
|
@diogomene is attempting to deploy a commit to the Piqnt Team on Vercel. A member of the Team first needs to authorize it. |
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.
What was done?
The SonarQube tool was used to identify code smells related to commented-out code fragments with no apparent purpose in the codebase. Each occurrence was reviewed manually, and if a comment was deemed unnecessary, it was removed.
However, some instances provided valuable context, such as explanations of mathematical rules or detailed descriptions of complex functions, serving as important elements for understanding or learning from the code. Therefore, 8 out of 87 code smell occurrences were identified as valid and useful comments for the project and were retained.
Evidences?
The following issues were found by SonarQube, during analysis:
planckJsIssuesSonarQube.json
It was filtered and analyzed within an simple NodeJS script.
Resolve #296