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

Refactor helpClicked() method in AlgorithmDialog #38735

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

darshdinger
Copy link
Collaborator

Description of work

This pull request refactors the helpClicked() method in AlgorithmDialog to utilize InterfaceManager for displaying algorithm help instead of directly calling HelpWindow. 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:

    • Replaced the direct call to HelpWindow::showAlgorithm with a call to InterfaceManager().showAlgorithmHelp.
    • This modification aligns the method with the updated design for help functionality that supports the Python-based HelpWindow.
  • Purpose of the Refactor:

    • Facilitates the transition to the Python-based HelpWindow by leveraging InterfaceManager as a single point of entry for help functionality.
    • Simplifies the maintenance and future extension of help-related features.

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

  • 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.

@darshdinger darshdinger changed the base branch from main to ornl-next January 28, 2025 19:05
@sf1919 sf1919 added the ornl-next A copy of a branch into the ornl-next fork label Jan 29, 2025
@darshdinger darshdinger changed the base branch from ornl-next to main January 29, 2025 14:46
@sf1919 sf1919 removed the ornl-next A copy of a branch into the ornl-next fork label Jan 29, 2025
@darshdinger darshdinger marked this pull request as ready for review February 12, 2025 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants