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

Use ADSObserver in ContourPreviewPlot widget #37411

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented May 23, 2024

Description of work

This PR ensures the ContourPreviewPlot widget uses the ADSObserver class to observe changes in the ADS. This makes the code simpler in the ContourPreviewPlot, and also helps avoid a bug as the ADSObserver class will make sure the previewplot is not subscribed to ADS notifications more than once. This has caused a crash in the past for other similar widgets: #37074

To test:

I have not found a crash for this widget. I think because the watchADS function is not called on the ContourPreviewPlot from outside the widget. Just do a simple test to make sure Inelastic S(Q,w) is still working:

  1. Open Inelastic Data Manipulations
  2. Go to S(Q,w) tab
  3. Load irs26176_graphite002_red file from sample data
  4. Click Run. It should run without a crash or an error

This does not require release notes because there is no user-facing change

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.

@robertapplin robertapplin added Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Indirect/Inelastic Issues and pull requests related to indirect or inelastic Maintenance Unassigned issues to be addressed in the next maintenance period. ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS labels May 23, 2024
@robertapplin robertapplin marked this pull request as ready for review May 23, 2024 17:15
Copy link
Contributor

@jhaigh0 jhaigh0 left a comment

Choose a reason for hiding this comment

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

Nice simplifying change

@SilkeSchomann SilkeSchomann self-assigned this May 28, 2024
@SilkeSchomann SilkeSchomann merged commit 599d3bf into mantidproject:main May 28, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Indirect/Inelastic Issues and pull requests related to indirect or inelastic ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

3 participants