Skip to content
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

Fix cppcheck suppressions set 8 #38753

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

MohamedAlmaki
Copy link
Contributor

@MohamedAlmaki MohamedAlmaki commented Jan 29, 2025

Description of work

This PR fixes CppCheck suppression set 8 as part of the CppCheck hackathon.

Issue File Line
knownConditionTrueFalse ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/AbsorptionCorrection.cpp 445
constParameterPointer ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/AddLogDerivative.cpp 54
variableScope ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/AddLogDerivative.cpp 72
constParameterReference ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/AddTimeSeriesLog.cpp 111
constParameterReference ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/AnnularRingAbsorption.cpp 206
constParameterReference ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/AppendSpectra.cpp 142
constVariablePointer ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/ApplyDetailedBalance.cpp 61
constVariablePointer ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/AverageLogData.cpp 69
constVariablePointer ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/AverageLogData.cpp 73
variableScope ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/CalculateCountRate.cpp 204
constVariablePointer ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/CalculateCountRate.cpp 669
constVariableReference ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/CalculateEfficiency.cpp 158
constVariableReference ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/CalculateEfficiency.cpp 159
constVariablePointer ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/CalculatePlaczek.cpp 166
constParameterReference ${CMAKE_SOURCE_DIR}/Framework/Algorithms/src/CalculatePolynomialBackground.cpp 174

There is no associated issue.

To test:

Test passes and code review


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@MohamedAlmaki MohamedAlmaki force-pushed the suppression-set-8 branch 2 times, most recently from dff0f84 to 3c1391e Compare January 29, 2025 17:20
@sf1919 sf1919 added the Maintenance Unassigned issues to be addressed in the next maintenance period. label Jan 29, 2025
@sf1919 sf1919 added this to the Release 6.13 milestone Jan 29, 2025
@MohamedAlmaki MohamedAlmaki marked this pull request as ready for review February 4, 2025 09:43
Copy link
Contributor

@GuiMacielPereira GuiMacielPereira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most changes are adding const which is straight-forward.
The most relevant part of this PR is the suppression on AbsorptionCorrection.cpp, the comment on why it's suppressed is well explained and also helps with the review of https://github.com/mantidproject/mantid/pull/38717/files#diff-53cf1b711a6bdf4085c241ffa73eb1bd022d2801fd31b7f628ea52472f7ed5c9R423


// L2s is initiliazed by m_numVolumeElements which is set to 0 in this class but it is overriden in subclasses
// like FlatAbsorptionCorrection
// cppcheck-suppress knownConditionTrueFalse
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the same file as in https://github.com/mantidproject/mantid/pull/38717/files#diff-53cf1b711a6bdf4085c241ffa73eb1bd022d2801fd31b7f628ea52472f7ed5c9R423, and I really appreciate your comment on why this should be suppressed

@thomashampson thomashampson self-assigned this Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

4 participants