-
Notifications
You must be signed in to change notification settings - Fork 11
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
Closed
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
3 tasks
e10harvey
changed the title
Doc strings exist common
Check opencsp.common for doc strings
Nov 11, 2024
- test for doc strings
Reviewers, I'd be happy to break this into separate PRs, one for each of:
|
Closing in favor of separate, smaller PRs. |
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
Ensure that public entities in opencsp/common have doc strings. Related to #36.
Summary of changes
Implementation notes
Ran
pytest -k test_docstrings
Submission checklist
develop
, notmain
opencsp/test/test_DocStringsExist.py
are verified to include this change or have been updated accordinglydoc/
are verified to include this change or have been updated accordinglyAdditional information
TODOs: