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

Remove isReadable/HDFVersion from NexusHDF5Descriptor and try/catch instead #38795

Merged

Conversation

rosswhitfield
Copy link
Member

@rosswhitfield rosswhitfield commented Feb 6, 2025

Description of work

Follow on from #38786, this changes how which Nexus Descriptor is used.

This removes the isReadable or HDFVersion functions and uses H5::H5File::isHdf5 where possible, other handle any exceptions.

Summary of work

Refs #38332

Further detail of work

To test:


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.

@rosswhitfield rosswhitfield added this to the Release 6.13 milestone Feb 6, 2025
@rosswhitfield rosswhitfield added ORNL Team Issues and pull requests managed by the ORNL development team Technical Debt Marks a piece of work to address technical debt introduced to solve a problem quickly labels Feb 6, 2025
@rosswhitfield rosswhitfield force-pushed the NexusHDF5Descriptor_updates3 branch 3 times, most recently from e3a2a4d to 811bc57 Compare February 6, 2025 23:43
@rosswhitfield rosswhitfield marked this pull request as ready for review February 7, 2025 03:53
Copy link
Member

@peterfpeterson peterfpeterson left a comment

Choose a reason for hiding this comment

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

I'm not a huge fan of using exceptions in the standard operation for an if/else sort of thing, but the code is indeed easier to follow in this new form.

@rboston628 rboston628 merged commit 3a15689 into mantidproject:main Feb 10, 2025
10 checks passed
@rosswhitfield rosswhitfield deleted the NexusHDF5Descriptor_updates3 branch February 10, 2025 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ORNL Team Issues and pull requests managed by the ORNL development team Technical Debt Marks a piece of work to address technical debt introduced to solve a problem quickly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants