common/lib/cv: Test docs #189
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bbean23
previously approved these changes
Dec 11, 2024
opencsp/common/lib/cv/spot_analysis/SpotAnalysisOperablesStream.py
Outdated
Show resolved
Hide resolved
opencsp/common/lib/cv/spot_analysis/SpotAnalysisOperablesStream.py
Outdated
Show resolved
Hide resolved
opencsp/common/lib/cv/spot_analysis/SpotAnalysisOperablesStream.py
Outdated
Show resolved
Hide resolved
| """ | ||
| # "ChatGPT 4o-mini" assisted with generating this docstring. |
| @@ -5,15 +5,53 @@ | |||
| import opencsp as opencsp | |||
| import example as example | |||
|
|
|||
| # TODO: why aren't these imported from import opencsp as opencsp above | |||
There was a problem hiding this comment.
We generally don't want to import the world when importing opencsp, so we don't auto-import everything in the base /init.py file. Instead, we depend on the developer to import everything they need.
We should replace the 'from opencsp... import ...' in lines 9-14 with 'import opencsp...', to match the rest of this file's imports.
There was a problem hiding this comment.
OK, please file an issue so we can take care of this in a follow-on PR.
e10harvey
force-pushed
the
doc_strings_exist_common_cv
branch
from
942e4c7 to
b3a4b08
Compare
e10harvey
force-pushed
the
doc_strings_exist_common_cv
branch
from
8c44dad to
d253607
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Test and complete docs in common/lib/cv
Summary of changes
Update test_DocStringsExists to include all members of common/lib/cv. Add missing doc strings
Implementation notes
Ran
pytest -s -k test_docstringsSubmission checklist
develop, notmainopencsp/test/test_DocStringsExist.pyare verified to include this change or have been updated accordinglydoc/are verified to include this change or have been updated accordinglyAdditional information
Please provide any additional information here.