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 return values to API reference for dfs method #1125

Merged
merged 12 commits into from
Aug 31, 2020
Merged

Conversation

gsheni
Copy link
Contributor

@gsheni gsheni commented Aug 27, 2020

Add return values to API reference for dfs method

@gsheni gsheni requested a review from rwedge August 27, 2020 16:41
@gsheni gsheni self-assigned this Aug 27, 2020
@codecov
Copy link

codecov bot commented Aug 27, 2020

Codecov Report

Merging #1125 into main will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1125   +/-   ##
=======================================
  Coverage   98.35%   98.35%           
=======================================
  Files         126      126           
  Lines       13309    13309           
=======================================
  Hits        13090    13090           
  Misses        219      219           
Impacted Files Coverage Δ
featuretools/entityset/deserialize.py 100.00% <ø> (ø)
featuretools/synthesis/dfs.py 100.00% <ø> (ø)
...computational_backends/calculate_feature_matrix.py 99.07% <100.00%> (ø)
featuretools/utils/gen_utils.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 94aaf51...231d261. Read the comment docs.

Copy link
Contributor

@rwedge rwedge left a 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

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.
Copy link
Contributor

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

Copy link
Contributor

@rwedge rwedge left a comment

Choose a reason for hiding this comment

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

Looks good!

@gsheni gsheni merged commit 03b03ac into main Aug 31, 2020
@gsheni gsheni deleted the add_dfs_output_docs branch August 31, 2020 22:33
@tamargrey tamargrey mentioned this pull request Sep 8, 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.

2 participants