Skip to content

Add join family without default definition #36

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

Merged
merged 4 commits into from
May 4, 2021

Conversation

iblislin
Copy link
Contributor

@iblislin iblislin commented May 2, 2021

close JuliaData/Tables.jl#238

Well, I think the default definition isn't trivial to implement, so I just setup the interface functions.
I don't restrict the parameter of join key, which is the kwarg on in DataFrames.jl, since the join key is optional in some cases of time series join.

src/DataAPI.jl Outdated
@@ -183,4 +183,102 @@ default definition.
function unwrap end
unwrap(x) = x

"""
innerjoin(x, y, zs...)
Copy link
Member

Choose a reason for hiding this comment

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

Two small comments:

  1. Here and below I would drop zs, as other packages do not have to provide this.
  2. I think it would be good to mention a reference (or add a description) to what a given type of join does. Ideally (if it is possible to do it relatively easily and in a generic way) - maybe also add a comment that the way key columns are determined is implementation specific and that key equality rules are also implementation specific.

Copy link
Member

Choose a reason for hiding this comment

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

Actually I'm not sure it's very useful to provide docstrings. Packages will have to provide more specific docstrings anyway, and the default docstrings are even misleading as on may be required by some packages.

For pairwise in StatsAPI I just added a comment for the same reason. I think that makes sense since that documentation is intended at package authors rather than end users.

Copy link
Member

Choose a reason for hiding this comment

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

I am OK to fully remove docstrings.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I remove the docstrings and add some code comments, since it's face to developers.

@codecov
Copy link

codecov bot commented May 2, 2021

Codecov Report

Merging #36 (c4d6089) into main (c46688c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #36   +/-   ##
=======================================
  Coverage   91.30%   91.30%           
=======================================
  Files           1        1           
  Lines          23       23           
=======================================
  Hits           21       21           
  Misses          2        2           
Impacted Files Coverage Δ
src/DataAPI.jl 91.30% <ø> (ø)

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 c46688c...c4d6089. Read the comment docs.

@ararslan ararslan merged commit 637ed59 into JuliaData:main May 4, 2021
@iblislin iblislin deleted the ib/join branch May 7, 2021 10:32
@bkamins bkamins mentioned this pull request Jun 13, 2021
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.

Interface for join methods
4 participants