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

Maintenance for the SANSTubeCalibration algorithm #38773

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

rbauststfc
Copy link
Contributor

Description of work

Summary of work

Address some of the maintenance items on the linked issue for the SANS tube calibration algorithms.

Refs #35982.

Further detail of work

  • I've added type annotations. I'm not personally that keen on importing objects just for type annotating (since we don't actually use the annotations for running a type checker), so I haven't imported MatrixWorkspace, for example. Obviously I'm happy to change this if people prefer, though.
  • I've added some documentation for the FlatTopPeak function. I'm afraid this was a function that I didn't write so I have only been able to add very basic documentation, however this seems consistent with several of our fitting functions.
  • I improved an error message and marked a method as static.

To test:

All tests should pass. As this is just maintenance work, I don't think it needs a manual test.

This does not require release notes because there are no user facing changes.


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.

@rbauststfc rbauststfc added SANS Issues and pull requests related to SANS Maintenance Unassigned issues to be addressed in the next maintenance period. ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS labels Jan 31, 2025
@rbauststfc rbauststfc added this to the Release 6.13 milestone Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS Maintenance Unassigned issues to be addressed in the next maintenance period. SANS Issues and pull requests related to SANS
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

1 participant