common/lib/camera: Test docs

[e10harvey]

Purpose

Test and complete docs in common/lib/camera

Summary of changes

Update test_DocStringsExists to include all members of common/lib/camera. Add missing doc strings

Implementation notes

Ran pytest -s -k test_docstrings

Submission checklist

• Target branch is develop, not main
• Existing tests are updated or new tests were added
• opencsp/test/test_DocStringsExist.py are verified to include this change or have been updated accordingly
• .rst file(s) under doc/ are verified to include this change or have been updated accordingly

Additional information

#189 should be merged before this is reviewed.

[braden6521]

Thank you @e10harvey for this code update. Everything technical looks good; thanks for adding documentation where it's needed. I do have one comment relating to UCamera.py:

Currently, UCamera.py is an out-of-date camera class that is part of the UFACET code base. Currently, it is only used in UFACET scripts in the contrib/app/ufacet-s and app/ufacet-s directories. I believe (although I am not the expert on UFACET), that the UFACET code base is somewhat unfinished and not unit tested fully, and in some cases not at all. How to bring the Ufacet code up to OpenCSP standards is a problem for another time. But for now, I propose moving the UCamera class into the app/ufacet-s directory. The motivation behind this is that is reduces clutter in the camera directory and reduces potential confusion when someone new is trying to use OpenCSP for the first time. I believe at one point the thought was to integrate UCamera.py with Camera.py, but that likely won't happen any time soon, so maybe this is the next best thing.

Let me know what you think.

[e10harvey]

Thank you @e10harvey for this code update. Everything technical looks good; thanks for adding documentation where it's needed. I do have one comment relating to UCamera.py:

Currently, UCamera.py is an out-of-date camera class that is part of the UFACET code base. Currently, it is only used in UFACET scripts in the contrib/app/ufacet-s and app/ufacet-s directories. I believe (although I am not the expert on UFACET), that the UFACET code base is somewhat unfinished and not unit tested fully, and in some cases not at all. How to bring the Ufacet code up to OpenCSP standards is a problem for another time. But for now, I propose moving the UCamera class into the app/ufacet-s directory. The motivation behind this is that is reduces clutter in the camera directory and reduces potential confusion when someone new is trying to use OpenCSP for the first time. I believe at one point the thought was to integrate UCamera.py with Camera.py, but that likely won't happen any time soon, so maybe this is the next best thing.

Let me know what you think.

I agree and I filed #196 for this.