Sirt documentation improvements - Githubissues

TomographicImaging / CIL

A versatile python framework for tomographic imaging

https://tomographicimaging.github.io/CIL/

Apache License 2.0

98 stars 45 forks source link

Sirt documentation improvements #1959

Closed MargaretDuff closed 3 weeks ago

MargaretDuff commented 1 month ago

Changes

Removed the confusing *s
Added a missing transpose
made the example equation consistent with the code

Testing you performed

Please add any demo scripts to https://github.com/TomographicImaging/CIL-Demos/tree/main/misc

Related issues/links

Closes #1957

Checklist

[x] I have performed a self-review of my code
[x] I have added docstrings in line with the guidance in the developer guide
[x] I have updated the relevant documentation ~~[] I have implemented unit tests that cover any new or modified functionality~~ ~~[ ] CHANGELOG.md has been updated with any functionality change~~
[x] Request review from all relevant developers
[x] Change pull request label to 'Waiting for review'

Contribution Notes

Please read and adhere to the developer guide and local patterns and conventions.

[x] The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in CIL (the Work) under the terms and conditions of the Apache-2.0 License
[x] I confirm that the contribution does not violate any intellectual property rights of third parties

MargaretDuff commented 1 month ago

MargaretDuff commented 1 month ago

Thanks @hrobarts - they were all good spots! Have updated the relevant lines

MargaretDuff commented 4 weeks ago

@hrobarts @lauramurgatroyd The documentation is now: (Ignore the first duplicate here - that is just my screen shot!)

hrobarts commented 3 weeks ago

Looks good to me :) thanks Margaret