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

Update ISIS Reflectometry GUI manual testing instructions #37206

Conversation

rbauststfc
Copy link
Contributor

Description of work

Summary of work

Updates the manual testing instructions for the ISIS Reflectometry GUI based on feedback from 6.9 release testing.

Fixes #36728.

To test:

  • Build the dev-docs-html target and check that the changes render OK.
  • Check that the changes address the updates requested on the linked issue.

This does not require release notes because it is just a testing documentation update.


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 Reflectometry Issues and pull requests related to reflectometry Documentation Issues and pull requests related to documentation ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS labels Apr 24, 2024
@rbauststfc rbauststfc added this to the Release 6.10 milestone Apr 24, 2024
@rbauststfc rbauststfc force-pushed the 36728_update_Reflectometry_manual_testing_instructions branch from 26c45a4 to 792b963 Compare April 24, 2024 13:26
@rbauststfc rbauststfc marked this pull request as ready for review April 24, 2024 16:00
@cailafinn cailafinn self-assigned this May 1, 2024
Copy link
Contributor

@cailafinn cailafinn left a comment

Choose a reason for hiding this comment

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

Reviewed changes in both the .rst code and in the built HTML, formatting and readability all looks right. Instructions are clear and can be followed on the GUI easily.

Great to have these in for the next release. Nice. :shipit:

@SilkeSchomann SilkeSchomann merged commit bc9169a into mantidproject:main May 2, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS Reflectometry Issues and pull requests related to reflectometry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Reflectometry GUI manual testing documentation
3 participants