Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check opencsp.common for doc strings #179

Closed

Conversation

e10harvey
Copy link
Collaborator

@e10harvey e10harvey commented Nov 11, 2024

Purpose

Ensure that public entities in opencsp/common have doc strings. Related to #36.

Summary of changes

  • Updated test_docstrings_exist to check opencsp/common
  • Added missing doc strings

Implementation notes

Ran pytest -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

TODOs:

  • camera
  • csp
  • csp/ufacet
  • cv
  • cv/annotations
  • cv/fiducials
  • cv/spot_analysis (Skipped in favor of 177 RST stubs for ReadTheDocs #178)
  • deflectometry
  • file
  • geo
  • geometry
  • opencsp_path
  • photogrammetry
  • process
  • process/lib
  • render
  • render/lib
  • render_control
  • target
  • tool
  • uas

@e10harvey e10harvey changed the title Doc strings exist common Check opencsp.common for doc strings Nov 11, 2024
@e10harvey e10harvey marked this pull request as ready for review November 12, 2024 20:39
@e10harvey e10harvey requested a review from bbean23 November 12, 2024 20:39
@e10harvey e10harvey requested a review from mhhwang1 November 12, 2024 20:39
@e10harvey e10harvey marked this pull request as draft November 12, 2024 20:46
@e10harvey e10harvey marked this pull request as ready for review November 13, 2024 15:37
@e10harvey
Copy link
Collaborator Author

e10harvey commented Nov 13, 2024

Reviewers, I'd be happy to break this into separate PRs, one for each of:

  • camera
  • csp
  • csp/ufacet
  • cv
  • cv/annotations
  • cv/fiducials
  • cv/spot_analysis (Skipped in favor of 177 RST stubs for ReadTheDocs #178)
  • deflectometry
  • file
  • geo
  • geometry
  • opencsp_path
  • photogrammetry
  • process
  • process/lib
  • render
  • render/lib
  • render_control
  • target
  • tool
  • uas

@e10harvey
Copy link
Collaborator Author

Closing in favor of separate, smaller PRs.

@e10harvey e10harvey closed this Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant