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

Fix documentation for enums #1391

Merged
merged 18 commits into from
Nov 3, 2020
Merged

Fix documentation for enums #1391

merged 18 commits into from
Nov 3, 2020

Conversation

angela97lin
Copy link
Contributor

Closes #1332 by updating our enums to show the attributes (values) of each enum.
ModelFamily
ProblemTypes
DataCheckMessageType

Before:
ModelFamily

@angela97lin angela97lin self-assigned this Nov 2, 2020
@codecov
Copy link

codecov bot commented Nov 2, 2020

Codecov Report

Merging #1391 into main will increase coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1391      +/-   ##
==========================================
+ Coverage   99.95%   99.95%   +0.01%     
==========================================
  Files         213      213              
  Lines       13928    13929       +1     
==========================================
+ Hits        13921    13922       +1     
  Misses          7        7              
Impacted Files Coverage Δ
evalml/data_checks/data_check_message.py 100.00% <ø> (ø)
evalml/model_family/model_family.py 100.00% <ø> (ø)
evalml/problem_types/problem_types.py 100.00% <ø> (ø)
evalml/data_checks/data_check_message_type.py 100.00% <100.00%> (ø)

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 24281e9...3a75984. Read the comment docs.

Copy link
Contributor

@bchen1116 bchen1116 left a comment

Choose a reason for hiding this comment

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

Docs look great!

@@ -8,7 +8,7 @@ class DataCheckMessage:

def __init__(self, message, data_check_name):
"""
Message returned by a DataCheck, tagged by name."
Message returned by a DataCheck, tagged by name.
Copy link
Contributor

Choose a reason for hiding this comment

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

nice catch!

Copy link
Contributor

@dsherry dsherry left a comment

Choose a reason for hiding this comment

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

Looks great, thank you!

@angela97lin angela97lin merged commit 102f741 into main Nov 3, 2020
@angela97lin angela97lin deleted the enum_docs branch November 3, 2020 18:10
@angela97lin angela97lin added this to the November 2020 milestone Nov 3, 2020
@dsherry dsherry mentioned this pull request Nov 24, 2020
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.

Update docs for enums to include values and more information
3 participants