Skip to content

Conversation

ktactac-ornl
Copy link
Contributor

@ktactac-ornl ktactac-ornl commented Sep 17, 2024

Description of work

Creates TableWorkspaceValidator and TableWorkspaceNotEmptyValidator as an example.

Summary of work

TableWorkspaceValidator class is created and exposed to the python api
TableWorkspaceNotEmptyValidator inherits and validates that a TableWorkspace is not empty, and is exposed to the python api.
Future derived classes can follow suite.
WorkspaceValidators.cpp is created to expose the classes.

Implementation is analogous to the already existingMatrixWorkspaceValidator

To extend the ability of validation to TableWorkspaces.

Fixes #xxxx.

6817: Expose WorkspaceValidators to Python

Further detail of work

To test:

Follow the mantid documentation for python unit testing

PYTHONPATH=/path/to/build/bin python3 /path/to/src/Framework/PythonInterface/test/python/mantid/dataobjects/WorkspaceValidators.py

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.

@ktactac-ornl ktactac-ornl marked this pull request as ready for review September 18, 2024 17:52
@sf1919 sf1919 added this to the Release 6.12 milestone Sep 19, 2024
Copy link
Contributor

@dlcaballero16 dlcaballero16 left a comment

Choose a reason for hiding this comment

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

Code looks good and tests run and pass as expected.

@KedoKudo KedoKudo merged commit dafaacf into main Sep 23, 2024
11 checks passed
@ktactac-ornl ktactac-ornl deleted the ewm6817-create-TableWorkspaceValidator branch September 24, 2024 15:31
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.

4 participants