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

get_join_indices function #1312

Merged
merged 23 commits into from
Jan 4, 2024
Merged

get_join_indices function #1312

merged 23 commits into from
Jan 4, 2024

Conversation

samukweku
Copy link
Collaborator

@samukweku samukweku commented Dec 8, 2023

PR Description

Please describe the changes proposed in the pull request:

  • Allow only matching indices to be returned. These are positional indices.

This PR resolves #1310 .

PR Checklist

Please ensure that you have done the following:

  1. PR in from a fork off your branch. Do not PR from <your_username>:dev, but rather from <your_username>:<feature-branch_name>.
  1. If you're not on the contributors list, add yourself to AUTHORS.md.
  1. Add a line to CHANGELOG.md under the latest version header (i.e. the one that is "on deck") describing the contribution.
    • Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.

Automatic checks

There will be automatic checks run on the PR. These include:

  • Building a preview of the docs on Netlify
  • Automatically linting the code
  • Making sure the code is documented
  • Making sure that all tests are passed
  • Making sure that code coverage doesn't go down.

Relevant Reviewers

Please tag maintainers to review.

@ericmjl
Copy link
Member

ericmjl commented Dec 8, 2023

Copy link

codecov bot commented Dec 8, 2023

Codecov Report

Merging #1312 (a7a079d) into dev (44152a2) will increase coverage by 0.58%.
Report is 2 commits behind head on dev.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #1312      +/-   ##
==========================================
+ Coverage   93.91%   94.49%   +0.58%     
==========================================
  Files          78       78              
  Lines        4254     4254              
==========================================
+ Hits         3995     4020      +25     
+ Misses        259      234      -25     

@samukweku samukweku added the enhancement New feature or request label Dec 10, 2023
Copy link
Member

@ericmjl ericmjl left a comment

Choose a reason for hiding this comment

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

Pre-approving the PR, @samukweku. I have only one comment about the name of return_indices as an argument.

@samukweku samukweku changed the title Samukweku/cond join indices only get_join_indices function Dec 19, 2023
@samukweku
Copy link
Collaborator Author

@ericmjl i created a separate function to return join indices - keeping the existing function as is. I feel it'd align more with pyjanitor's original goal of ensuring a dataframe is always returned.

@samukweku samukweku requested a review from a team December 28, 2023 02:32
@ericmjl
Copy link
Member

ericmjl commented Jan 3, 2024

@samukweku I'm good with the latest changes! Thank you for working hard on this PR. Are you good for merging?

@ericmjl
Copy link
Member

ericmjl commented Jan 4, 2024

Okie dokes, saw your thumbs up, let's merge!

@ericmjl ericmjl merged commit 92665c8 into dev Jan 4, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Return only matching indices for conditional_join
2 participants