Update SaveISISReflectometryORSO with a Class diagram #38389
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduced a UML class diagram to the documentation to illustrate the main classes supporting the SaveISISReflectometryORSO algorithm and their relationships. This should help users and developers to better understand the structure and dependencies involved. Signed-off-by: Jose Borreguero <borreguero@gmail.com>
Changed the image width from 80% to 70% in the documentation for the SaveISISReflectometryORSO algorithm. This adjustment aims to improve layout and readability within the documentation. Signed-off-by: Jose Borreguero <borreguero@gmail.com>
Deleted the outdated class diagram image and its references from the documentation. Also, added a new section under `mantid.utils` for reflectometry utilities, detailing the `orso_helper` module and its functionality. Signed-off-by: Jose Borreguero <borreguero@gmail.com>
|
class diagram moved to its own documentation page |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of work
Added a class diagram showing the main classes supporting the algorithm, and their relationships.
There is no associated issue. References EWM 8154
To test:
build the documentation (
ninja docs-html) and verify the documentation for algorithm SaveISISReflectometryORSO has sectionClass Diagramshowing the following picture:This does not require release notes because is a minor addendum and only of interest only to developers.
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
Functional Tests
Does everything look good? Mark the review as Approve. A member of
@mantidproject/gatekeeperswill 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.