Improve SumIntensitiesFilter docstrings to enhance user-facing explan…#3142
Draft
ashleymeigh2 wants to merge 1 commit into
Draft
Improve SumIntensitiesFilter docstrings to enhance user-facing explan…#3142ashleymeigh2 wants to merge 1 commit into
ashleymeigh2 wants to merge 1 commit into
Conversation
|
coverage: 67.998%. remained the same — improve-SumIntensitiesFilter-docstrings-for-user into main |
Collaborator
|
Does this PR link to an Issue? Maybe #3074 ? |
JackEAllen
requested changes
May 7, 2026
Collaborator
JackEAllen
left a comment
JackEAllen
left a comment
There was a problem hiding this comment.
Thank you for cleaning up after me and adding an improved docstring for the API docs. Looks good! Just a few suggestions
Comment on lines
+33
to
+34
| - Projection angles are not required but, if present, are checked for | ||
| consistency and may trigger a warning if mismatched. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Projection angles are not required but, if present, are checked for | |
| consistency and may trigger a warning if mismatched. | |
| - Projection angles are not required. If present, projections are sorted into angle order on load | |
| (see :func:`loader.load <mantidimaging.core.io.loader.loader.load>`). | |
| If matched angles between stacks to be summed together differ, a warning is raised. |
| """ | ||
| Validate stacks and sum their intensities in-place. | ||
| :param images: Primary ImageStack to be modified. | ||
| :param secondary_stack: Secondary ImageStack whose values are added. |
Collaborator
There was a problem hiding this comment.
Suggested change
| :param secondary_stack: Secondary ImageStack whose values are added. | |
| :param secondary_stack: Secondary ImageStack whose values are added to the primary stack |
| Validate stacks and sum their intensities in-place. | ||
| :param images: Primary ImageStack to be modified. | ||
| :param secondary_stack: Secondary ImageStack whose values are added. | ||
| :param progress: Progress reporting object (unused). |
Collaborator
There was a problem hiding this comment.
NIPICK (Entirely optional): As this is user facing, may be handy to provide context explaining why Progress is not used.
Suggested change
| :param progress: Progress reporting object (unused). | |
| :param progress: Progress reporting object (unused - no meaningful progress updates to report as operation runs as a single vectorised operation). |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
…ations
Issue Closes #
Description
Improve and standardise docstrings for SumIntensitiesFilter to better support user-facing documentation and in-application guidance. These changes improve readability for developers and enhance downstream user documentation (e.g. tooltips, generated docs).
Developer Testing
python -m pytest -vsAcceptance Criteria and Reviewer Testing
python -m pytest -vsDocumentation and Additional Notes