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

Add comments to doctests #3155

Merged
merged 7 commits into from
Dec 16, 2021
Merged

Add comments to doctests #3155

merged 7 commits into from
Dec 16, 2021

Conversation

ParthivNaresh
Copy link
Contributor

@ParthivNaresh ParthivNaresh commented Dec 15, 2021

Fixes: #3035

Previous docs:
Screen Shot 2021-12-16 at 4 32 01 PM

New docs: Added comments and split code blocks
Screen Shot 2021-12-16 at 4 32 13 PM


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.rst to include this pull request by adding :pr:123.

@ParthivNaresh ParthivNaresh self-assigned this Dec 15, 2021
@codecov
Copy link

codecov bot commented Dec 15, 2021

Codecov Report

Merging #3155 (57202c9) into main (93444ec) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #3155   +/-   ##
=====================================
  Coverage   99.7%   99.7%           
=====================================
  Files        318     318           
  Lines      30948   30948           
=====================================
  Hits       30843   30843           
  Misses       105     105           
Impacted Files Coverage Δ
evalml/data_checks/class_imbalance_data_check.py 100.0% <ø> (ø)
evalml/data_checks/datetime_format_data_check.py 100.0% <ø> (ø)
evalml/data_checks/datetime_nan_data_check.py 100.0% <ø> (ø)
evalml/data_checks/highly_null_data_check.py 100.0% <ø> (ø)
evalml/data_checks/id_columns_data_check.py 100.0% <ø> (ø)
evalml/data_checks/invalid_target_data_check.py 100.0% <ø> (ø)
evalml/data_checks/multicollinearity_data_check.py 100.0% <ø> (ø)
...lml/data_checks/natural_language_nan_data_check.py 100.0% <ø> (ø)
evalml/data_checks/no_variance_data_check.py 100.0% <ø> (ø)
evalml/data_checks/outliers_data_check.py 100.0% <ø> (ø)
... and 15 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 93444ec...57202c9. Read the comment docs.

@ParthivNaresh ParthivNaresh changed the title initial doctest comment Add comments to doctests Dec 16, 2021
@@ -39,6 +39,36 @@ def validate(self, X, y=None):
Returns:
dict: dict with a DataCheckError if parameters are too big for the split sizes.

Examples:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Realized there were no tests for TimeSeriesParametersDataCheck so I took this opportunity to add one

@ParthivNaresh ParthivNaresh marked this pull request as ready for review December 16, 2021 15:56
Copy link
Contributor

@freddyaboulton freddyaboulton left a comment

Choose a reason for hiding this comment

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

Thanks @ParthivNaresh this looks great!!

@ParthivNaresh ParthivNaresh merged commit 7bbc60a into main Dec 16, 2021
@angela97lin angela97lin mentioned this pull request Dec 22, 2021
@freddyaboulton freddyaboulton deleted the AddBriefCommentsToDoctests branch May 13, 2022 15:34
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.

Add brief comments to doctests
2 participants