Add return values to API reference for dfs method#1125
Merged
Conversation
added 3 commits
August 27, 2020 12:38
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.
|
rwedge
reviewed
Aug 28, 2020
Contributor
rwedge
left a comment
rwedge
left a comment
There was a problem hiding this comment.
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
added 2 commits
August 31, 2020 17:09
rwedge
reviewed
Aug 31, 2020
| 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. |
Contributor
There was a problem hiding this comment.
features_only should have double backticks
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add return values to API reference for dfs method