Refactor helpClicked() method in AlgorithmDialog #38735
Open
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.
Description of work
This pull request refactors the
helpClicked()
method inAlgorithmDialog
to utilizeInterfaceManager
for displaying algorithm help instead of directly callingHelpWindow
. This change is necessary to enable the integration of the new Python-based HelpWindow implementation while maintaining backward compatibility with existing functionality.Currently, this refactor leads to a segmentation fault and core dump (crash) when using the algorithm help button, which will require further investigation and resolution.
Summary of work
Refactored
helpClicked()
Method:HelpWindow::showAlgorithm
with a call toInterfaceManager().showAlgorithmHelp
.Purpose of the Refactor:
InterfaceManager
as a single point of entry for help functionality.Ref #37248
To test:
The testing details are to be filled in. This work is still not resolved. Therefore no testing details at the moment. This work is related to other branches named
37248-PHW-....
.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
Functional Tests
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.