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

Docstring tests #1749

Merged
merged 3 commits into from
Aug 3, 2021
Merged

Docstring tests #1749

merged 3 commits into from
Aug 3, 2021

Conversation

felixwang9817
Copy link
Collaborator

What this PR does / why we need it: Most of our important user-facing methods (apply, get_historical_features, etc.) have docstrings with interactive examples. This PR introduces tests for these interactive examples.

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

NONE

@codecov-commenter
Copy link

codecov-commenter commented Jul 30, 2021

Codecov Report

Merging #1749 (4428bd6) into master (1841bb3) will increase coverage by 0.34%.
The diff coverage is 95.65%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1749      +/-   ##
==========================================
+ Coverage   83.95%   84.30%   +0.34%     
==========================================
  Files          73       76       +3     
  Lines        6003     6084      +81     
==========================================
+ Hits         5040     5129      +89     
+ Misses        963      955       -8     
Flag Coverage Δ
integrationtests 84.22% <95.65%> (+0.34%) ⬆️
unittests 64.71% <95.65%> (+0.54%) ⬆️

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

Impacted Files Coverage Δ
...k/python/feast/infra/offline_stores/file_source.py 85.91% <ø> (ø)
sdk/python/feast/infra/utils/aws_utils.py 91.26% <ø> (ø)
sdk/python/tests/doctest/test_all.py 95.12% <95.12%> (ø)
sdk/python/feast/feature_store.py 93.58% <100.00%> (+0.50%) ⬆️
sdk/python/feast/registry.py 77.94% <0.00%> (-1.41%) ⬇️
sdk/python/feast/feature_view.py 87.05% <0.00%> (ø)
sdk/python/feast/wait.py 23.52% <0.00%> (ø)
sdk/python/feast/constants.py 100.00% <0.00%> (ø)
... and 1 more

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 1841bb3...4428bd6. 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.

/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 257b0f3 into feast-dev:master Aug 3, 2021
@felixwang9817 felixwang9817 deleted the doctest branch August 3, 2021 20:35
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.

4 participants