Skip to content

Add unit tests to enforce primitive docstring verb usage#2200

Merged
sbadithe merged 6 commits into
mainfrom
Docstring-Test
Jul 25, 2022
Merged

Add unit tests to enforce primitive docstring verb usage#2200
sbadithe merged 6 commits into
mainfrom
Docstring-Test

Conversation

@sbadithe

@sbadithe sbadithe commented Jul 22, 2022

Copy link
Copy Markdown
Contributor

Fixes #2199

-- Adds unit test that checks if primitive's docstring begins with verb in set of valid_verbs.
-- Rewords docstrings for primitives that would fail test above.

@sbadithe sbadithe changed the title Add docstring tests Add unit test to enforce primitive docstrings Jul 22, 2022
@codecov

codecov Bot commented Jul 22, 2022

Copy link
Copy Markdown

Codecov Report

Merging #2200 (ac259ec) into main (d2f0092) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #2200   +/-   ##
=======================================
  Coverage   99.29%   99.29%           
=======================================
  Files         145      146    +1     
  Lines       17556    17567   +11     
=======================================
+ Hits        17432    17443   +11     
  Misses        124      124           
Impacted Files Coverage Δ
...aturetools/primitives/standard/binary_transform.py 100.00% <ø> (ø)
...imitives/standard/datetime_transform_primitives.py 100.00% <ø> (ø)
...retools/primitives/standard/transform_primitive.py 100.00% <ø> (ø)
...s/primitive_tests/test_all_primitive_docstrings.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 d2f0092...ac259ec. Read the comment docs.

@sbadithe sbadithe changed the title Add unit test to enforce primitive docstrings Add unit tests to enforce primitive docstring verb usage Jul 22, 2022
@sbadithe sbadithe marked this pull request as ready for review July 22, 2022 20:10
@sbadithe sbadithe marked this pull request as draft July 22, 2022 20:12
@sbadithe sbadithe marked this pull request as ready for review July 22, 2022 20:37
@gsheni gsheni self-requested a review July 25, 2022 13:45

@gsheni gsheni left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@sbadithe sbadithe merged commit a76354c into main Jul 25, 2022
@sbadithe sbadithe deleted the Docstring-Test branch July 25, 2022 15:32
@rwedge rwedge mentioned this pull request Aug 4, 2022
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.

Add unit test to enforce primitive descriptions

2 participants