Add comments to doctests #3155
Merged
Add comments to doctests #3155
Conversation
This file contains hidden or 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
Codecov Report
@@ Coverage Diff @@
## main #3155 +/- ##
=====================================
Coverage 99.7% 99.7%
=====================================
Files 318 318
Lines 30948 30948
=====================================
Hits 30843 30843
Misses 105 105
Continue to review full report at Codecov.
|
ParthivNaresh
requested review from
angela97lin,
bchen1116,
christopherbunn,
chukarsten,
eccabay,
freddyaboulton and
jeremyliweishih
and removed request for
eccabay and
freddyaboulton
ParthivNaresh
commented
Dec 16, 2021
| Returns: | ||
| dict: dict with a DataCheckError if parameters are too big for the split sizes. | ||
| Examples: |
Contributor
Author
There was a problem hiding this comment.
Realized there were no tests for TimeSeriesParametersDataCheck so I took this opportunity to add one
freddyaboulton
approved these changes
Dec 16, 2021
Contributor
freddyaboulton
left a comment
freddyaboulton
left a comment
There was a problem hiding this comment.
Thanks @ParthivNaresh this looks great!!
Merged
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.
Fixes: #3035
Previous docs:
New docs: Added comments and split code blocks
After creating the pull request: in order to pass the release_notes_updated check you will need to update the "Future Release" section of
docs/source/release_notes.rstto include this pull request by adding :pr:123.