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

BinaryTransform docstrings #495

Merged
merged 10 commits into from Apr 19, 2019
Merged

Conversation

glentennis
Copy link
Contributor

Adding docstrings to BinaryTransform primitives, with a full description, args, and doctests.

@codecov
Copy link

codecov bot commented Apr 15, 2019

Codecov Report

Merging #495 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #495   +/-   ##
=======================================
  Coverage   96.08%   96.08%           
=======================================
  Files         108      108           
  Lines        8864     8864           
=======================================
  Hits         8517     8517           
  Misses        347      347
Impacted Files Coverage Δ
...aturetools/primitives/standard/binary_transform.py 99.65% <ø> (ø) ⬆️
...uretools/tests/utils_tests/test_list_primitives.py 100% <ø> (ø) ⬆️

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 dd2a8e3...543f8ec. Read the comment docs.

@gsheni gsheni assigned gsheni and unassigned gsheni Apr 16, 2019
@gsheni gsheni self-requested a review April 16, 2019 18:29
@@ -15,6 +15,18 @@


class GreaterThan(TransformPrimitive):
"""Determines if values X are greater than values Y.
Copy link
Contributor

Choose a reason for hiding this comment

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

what are X and Y? this should be "Determines if values in one list are greater than another list". fine to keep x and y in extended description below though

let's apply this rule to all the primitives below too

@gsheni gsheni merged commit 5a7e09e into alteryx:master Apr 19, 2019
@rwedge rwedge mentioned this pull request Apr 24, 2019
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.

None yet

3 participants