-
Notifications
You must be signed in to change notification settings - Fork 885
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 return values to API reference for dfs method #1125
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1125 +/- ##
=======================================
Coverage 98.35% 98.35%
=======================================
Files 126 126
Lines 13309 13309
=======================================
Hits 13090 13090
Misses 219 219
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think for the sphinx napoleon extension to parse the returns section correctly it needs to be in one of a few specific formats. This is one:
Returns:
return_type_1, return_type_2: description of return values
featuretools/synthesis/dfs.py
Outdated
Returns: | ||
list[:class:`.FeatureBase`], pd.DataFrame: | ||
The list of generated feature defintions, and the feature matrix. | ||
If `features_only` is ``True``, the feature matrix will not be generated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
features_only should have double backticks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Add return values to API reference for dfs method