Trivial operators - improve documentation

[MargaretDuff]

Changes

Improves the documentation for IdentityOperator, MatrixOperator and ZeroOperator.

Testing you performed

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

Related issues/links

Closes #1950

Checklist

• I have performed a self-review of my code
• I have added docstrings in line with the guidance in the developer guide
• 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
• Request review from all relevant developers
• Change pull request label to 'Waiting for review'

Contribution Notes

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

• 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
• I confirm that the contribution does not violate any intellectual property rights of third parties

--->

[lauramurgatroyd]

Great improvement but I had extra ideas/query

[lauramurgatroyd]

thanks for the updates!

[hrobarts]

Hi Margaret, these sound like good changes. I just checked the docs from the latest GHA build for this PR - is this rendering as you expect? I looked in the v24.2.0 and nightly folders, not sure if that's the right place.

[MargaretDuff]

Hi Margaret, these sound like good changes. I just checked the docs from the latest GHA build for this PR - is this rendering as you expect? I looked in the v24.2.0 and nightly folders, not sure if that's the right place.

Thanks Hannah! Did you look in the "1960_merge" folder?

[hrobarts]

Thanks Hannah! Did you look in the "1960_merge" folder?

Ahh sorry, I knew I was missing something 🤦‍♀️ Yes I can see the changes in the merge folder

[MargaretDuff]

Thanks Hannah! Did you look in the "1960_merge" folder?

Ahh sorry, I knew I was missing something 🤦‍♀️ Yes I can see the changes in the merge folder

Thanks Hannah - let me know if it looks ok or if you spot any typos

[hrobarts]

Thanks Hannah! Did you look in the "1960_merge" folder?

Ahh sorry, I knew I was missing something 🤦‍♀️ Yes I can see the changes in the merge folder

Thanks Hannah - let me know if it looks ok or if you spot any typos

Looks good to me. Just a question really, do we want to have the same thing in the function description and return? I would either make the description more wordy like "Computes the adjoint of the identity operator Id*(x) = x" or remove the description if the return is sufficient.

[MargaretDuff]

Thanks @hrobarts - I have tried to add more/different information to the docstring

[lauramurgatroyd]

new additions look great

[hrobarts]

Thanks @MargaretDuff looking good