Improve SumIntensitiesFilter docstrings to enhance user-facing explan…#3142
Improve SumIntensitiesFilter docstrings to enhance user-facing explan…#3142ashleymeigh2 wants to merge 2 commits into
Conversation
|
coverage: 67.947% (-0.05%) from 67.998% — improve-SumIntensitiesFilter-docstrings-for-user into main |
|
Does this PR link to an Issue? Maybe #3074 ? |
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
JackEAllen
left a comment
JackEAllen
left a comment
There was a problem hiding this comment.
Thanks for the changes, just one small comment to resolve a formatting issue and rebasing the commits to clean up the commit history / messages and this will be good to merge in
| Note: | ||
| - Both stacks must have identical shape (x, y, z). | ||
| - The z-axis typically represents projection angle or ToF bin. | ||
| - 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. | ||
| - The primary stack is modified in-place. |
There was a problem hiding this comment.
I think you may need to play around with the line spacing as when I build the docs locally, the bullet point list does not format nicely and function reference formats the whole line as a code block instead of an inline element. if you add an empty line after Note: this should resolve this so instead of:
You will get this:
3 participants
…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