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

Added warning for ADS.clear() #36548

Merged
merged 3 commits into from
Dec 19, 2023
Merged

Added warning for ADS.clear() #36548

merged 3 commits into from
Dec 19, 2023

Conversation

SilkeSchomann
Copy link
Contributor

Description of work

Calling clear() for the ADS now displays a warning.

Occasionally, users call clear() for the ADS in order to get rid of temporary workspaces. This can cause problems for some of our interfaces, as there might be hidden workspaces that are still in use by the interface. One example of this is MSlice: mantidproject/mslice#839

There is no associated issue.

To test:

Run the following script and check that the warning makes sense:

from mantid.simpleapi import *
import matplotlib.pyplot as plt
import numpy as np

from mantid import mtd

mtd.clear()

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.

@SilkeSchomann SilkeSchomann marked this pull request as ready for review December 13, 2023 09:42
@SilkeSchomann SilkeSchomann added ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS ISIS Team: Excitations/Vesuvio Issue and pull requests managed by the Excitiations/Vesuvio subteam at ISIS Framework Issues and pull requests related to components in the Framework labels Dec 13, 2023
@SilkeSchomann SilkeSchomann added this to the Release 6.9 milestone Dec 13, 2023
@jhaigh0 jhaigh0 self-assigned this Dec 14, 2023
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.

Works as intended :) Maybe it'd be nice to add an optional argument to clear() to make it output what workspaces its clearing (including hidden ones). Might help with debugging these kinds of problems

@RichardWaiteSTFC RichardWaiteSTFC merged commit 4e14bf7 into main Dec 19, 2023
9 checks passed
@RichardWaiteSTFC RichardWaiteSTFC deleted the 0_add_ads_clear_warning branch December 19, 2023 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Framework Issues and pull requests related to components in the Framework ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS ISIS Team: Excitations/Vesuvio Issue and pull requests managed by the Excitiations/Vesuvio subteam at ISIS
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

3 participants