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

Docstrings #1739

Merged
merged 11 commits into from
Jul 27, 2021
Merged

Docstrings #1739

merged 11 commits into from
Jul 27, 2021

Conversation

felixwang9817
Copy link
Collaborator

What this PR does / why we need it: This PR adds docstrings to public methods in public-facing classes (FeatureStore, FeatureView, Entity, etc.), and improves existing documentation.

Which issue(s) this PR fixes:

Fixes #1610

Does this PR introduce a user-facing change?:

Added docstrings

@codecov-commenter
Copy link

codecov-commenter commented Jul 27, 2021

Codecov Report

Merging #1739 (681b126) into master (489a0f8) will decrease coverage by 0.04%.
The diff coverage is 79.36%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1739      +/-   ##
==========================================
- Coverage   79.08%   79.04%   -0.05%     
==========================================
  Files          80       80              
  Lines        6855     6880      +25     
==========================================
+ Hits         5421     5438      +17     
- Misses       1434     1442       +8     
Flag Coverage Δ
integrationtests 78.96% <79.36%> (-0.05%) ⬇️
unittests 61.72% <77.77%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
sdk/python/feast/feature_service.py 71.21% <ø> (ø)
sdk/python/feast/feature_store.py 93.50% <0.00%> (ø)
sdk/python/feast/feature_table.py 44.05% <ø> (ø)
sdk/python/feast/feature_view.py 86.95% <62.50%> (-2.28%) ⬇️
sdk/python/feast/entity.py 73.98% <85.18%> (-2.60%) ⬇️
sdk/python/feast/data_source.py 57.00% <92.85%> (+0.81%) ⬆️
sdk/python/feast/feature.py 75.00% <100.00%> (ø)
sdk/python/feast/inference.py 89.79% <100.00%> (+0.21%) ⬆️
sdk/python/feast/infra/online_stores/dynamodb.py 93.67% <0.00%> (+2.53%) ⬆️

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 489a0f8...681b126. Read the comment docs.

Copy link
Member

@achals achals 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, mostly nits. Are doctests part of this PR or a different PR?

sdk/python/feast/data_source.py Outdated Show resolved Hide resolved
sdk/python/feast/entity.py Outdated Show resolved Hide resolved
sdk/python/feast/entity.py Outdated Show resolved Hide resolved
@felixwang9817
Copy link
Collaborator Author

Looks good, mostly nits. Are doctests part of this PR or a different PR?

Doctests are separate.

Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Signed-off-by: Felix Wang <wangfelix98@gmail.com>
Copy link
Member

@achals achals left a comment

Choose a reason for hiding this comment

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

/lgtm

@feast-ci-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: achals, felixwang9817

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@feast-ci-bot feast-ci-bot merged commit 8099ea7 into feast-dev:master Jul 27, 2021
@felixwang9817 felixwang9817 deleted the docstrings branch July 27, 2021 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docstrings to object constructors in Python reference API
5 participants