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

common/lib/csp: Test docs #191

Merged

Conversation

e10harvey
Copy link
Collaborator

@e10harvey e10harvey commented Nov 25, 2024

Purpose

Test and complete docs in common/lib/csp

Summary of changes

Update test_DocStringsExists to include all members of common/lib/csp. 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

#190 should be merged before this is reviewed.

@e10harvey e10harvey force-pushed the doc_strings_exist_common_csp branch from c1e6df6 to 45bc945 Compare November 27, 2024 17:02
@e10harvey e10harvey force-pushed the doc_strings_exist_common_csp branch 3 times, most recently from c647b76 to 0007f03 Compare December 19, 2024 00:02
braden6521
braden6521 previously approved these changes Dec 19, 2024
Copy link
Collaborator

@braden6521 braden6521 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Evan, thanks for putting this together. This is a lot of good work. I left a couple comments, but if they seem like they should belong in another PR, please ignore them.

opencsp/common/lib/csp/LightPathEnsemble.py Outdated Show resolved Hide resolved
opencsp/common/lib/csp/RayTrace.py Outdated Show resolved Hide resolved
opencsp/common/lib/csp/StandardPlotOutput.py Outdated Show resolved Hide resolved
@e10harvey e10harvey force-pushed the doc_strings_exist_common_csp branch from 0007f03 to a3d6891 Compare January 7, 2025 18:56
@e10harvey e10harvey merged commit b2addd5 into sandialabs:develop Jan 7, 2025
4 checks passed
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.

2 participants