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 for colourbar plot bug #35483

Merged
merged 2 commits into from
May 12, 2023
Merged

Fix for colourbar plot bug #35483

merged 2 commits into from
May 12, 2023

Conversation

jhaigh0
Copy link
Contributor

@jhaigh0 jhaigh0 commented Apr 26, 2023

Purpose of work
Fix for bug (introduced in #35195) where if you opened and applied plot setting on a colourfill (or contour) plot, the colour bar positioning would not be recognised, and the plot would draw underneath it.

Summary of work
Reverted my complicated changes required for using a tight layout and a colour bar. Now you can pass a layout engine to create_subplots() to allow the use of a constrained layout for plots with a colour bar. This is what's recommended.

Also altered some tests to make sense with the changes.

To test:

  • Load 164198.nxs, 164199.nxs, 164200.nxs and group them together.

  • Expand the group and plot a colourfill plot for 164198.nxs

  • As you resize the window, no text should become obscured and the plot should behave as expected

  • Open the plot settings (settings icon on the toolbar), change nothing, and click 'Apply'.

  • Nothing on the plot should change (apart from some very minor adjustments potentially).

  • Open the plot settings and change some settings (colour bar and axes limits and scales etc.)

  • The plot should update according to your changes

  • Now right-click the workspace group and plot a colourfill for all three workspaces.

  • Repeat the checks from before.

  • Also experiment with contour plots (they should be the same)

  • Check that other plot types have not been affected

There is no associated issue.

This does not require release notes because the functionality is covered by the original release note in #35195


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?
  • Are the release notes saved in a separate file, using Issue or PR number for file name and in the correct location?
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.

@jhaigh0 jhaigh0 added Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Reported By User Issues that were found or highlighted by a user/scientist ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS GUI Issues and pull requests specific to the Mantid Workbench GUI. labels Apr 26, 2023
@jhaigh0 jhaigh0 requested a review from eurydice76 April 28, 2023 09:24
Copy link
Contributor

@eurydice76 eurydice76 left a comment

Choose a reason for hiding this comment

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

Thanks for the work done for solving this regression.
I could apply the workflow designed for testing the fix and functionnally
everything seems OK.
The code by itself is OK for me.

@eurydice76
Copy link
Contributor

The build is OK. Could another gatekeeper validate it ? Thanks

@sf1919
Copy link
Contributor

sf1919 commented May 11, 2023

@mantidproject/gatekeepers Adding a screenshot to show that this has passed all its tests and has been approved so ready for gatekeeper review that @eurydice76 has requested

Screenshot (265)

@jhaigh0 jhaigh0 added this to the Release 6.7 milestone May 11, 2023
@SilkeSchomann SilkeSchomann merged commit 20e10ef into main May 12, 2023
@SilkeSchomann SilkeSchomann deleted the fix_colourfill_bug branch May 12, 2023 08:10
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) GUI Issues and pull requests specific to the Mantid Workbench GUI. ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS Reported By User Issues that were found or highlighted by a user/scientist
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants