[Feature]: quantum utils docstrings and tests

[aarontrowbridge]

Feature Description

We are looking for someone to write docstrings and tests for all of the functions in the file src/quantum_utils.jl.

Some docstrings are in place, but a lot are not. The extant ones, if necessary, should be expanded to include a description of the function and the arguments, in line with the blue style guidelines.

Implementation details

• Write docstrings for all of the functions in src/quantum_utils.jl
• Add tests for the functions in test/quantum_utils_test.jl

Importance

1 (lowest)

What does this feature affect?

• [ ] quantum system construction
• [ ] problem setup
• [ ] problem solution
• [ ] problem performance
• [ ] solution analysis
• [ ] plotting
• [X] documentation
• [X] tests
• [ ] other (please specify below)

Other information

No response

[Fe-r-oz]

Sounds interesting! I would like to work on this.

[andgoldschmidt]

@Fe-r-oz It's yours to pursue! Check the contribution guide for some notes regarding testing.

Feedback on the naming and interpretability of the utilities is appreciated at this time. We also welcome suggestions for missing utilities, filling gaps or improving what has currently been made available.

[Fe-r-oz]

Hi, @aarontrowbridge, Kindly please review the PR https://github.com/aarontrowbridge/QuantumCollocation.jl/pull/111. All the tests 5 passed

Since it has both documentation and testing, it's a little long. I tried best to follow the best practices from the guide this guide.. If there is something wrong, please let me know in the review.

I also included comments to better expain each and every test. I hope the PR satisfies the requirements. Thank you.

[Fe-r-oz]

Hi, Please close this issue as it's resolved! Thanks!