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 setMarkerStyle #38698

Open
wants to merge 1 commit into
base: release-next
Choose a base branch
from
Open

Fix setMarkerStyle #38698

wants to merge 1 commit into from

Conversation

searscr
Copy link
Contributor

@searscr searscr commented Jan 24, 2025

Description of work

This PR is to fix a typo from MatrixWorkspace.getMarkerType() to MatrixWorkspace.getMarkerStyle().

Summary of work

In an effort to improve plotting Matrix workspaces as Marker workspaces a function was added to MatrixWorkspace to set the marker style per workspace. A typo had getMarkerType rather than the correct function call of getMarkerStyle. This PR is to fix that typo as well as include input validation for marker style and plot type.

Fixes Defect EWM 8982

This defect arose while testing #38548 an exception was observed when trying to test the required ability to set custom marker type per workspace. When doing this via:

ws = CreateSampleWorkspace()
ws.setPlotType('marker')
ws.setMarkerStyle('point')

and then attempting to right-click plot the workspace yields an exception:

AttributeError: 'Workspace2D' object has no attribute 'getMarkerType'

To test:

The above workflow should produce a plot without an exception.


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.

@searscr searscr added 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. ORNL Team Issues and pull requests managed by the ORNL development team labels Jan 24, 2025
@searscr searscr added this to the Release 6.12 milestone Jan 24, 2025
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. ORNL Team Issues and pull requests managed by the ORNL development team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant