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

style(matchers): rename matchers funcs for clarity #137

Merged
merged 4 commits into from
Nov 27, 2024

Conversation

alhayward
Copy link
Contributor

@alhayward alhayward commented Nov 19, 2024

Description

  • Rename feature matching and evaluation functions for clarity

    Feature Matching

    • feature_match_any -> compare_match_any
    • feature_match_exact -> compare_match_all
    • feature_match_fuzzy_string -> compare_fuzzy_match
    • feature_match_log_odds_fuzzy_compare -> compare_probabilistic_fuzzy_match

    Evaluation

    • eval_perfect_match -> rule_match
    • eval_log_odds_cutoff -> rule_probabilistic_match

Related Issues

closes #109

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.43%. Comparing base (3182485) to head (396dc4f).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #137      +/-   ##
==========================================
+ Coverage   95.47%   96.43%   +0.95%     
==========================================
  Files          31       30       -1     
  Lines        1414     1317      -97     
==========================================
- Hits         1350     1270      -80     
+ Misses         64       47      -17     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@alhayward alhayward marked this pull request as ready for review November 19, 2024 23:35
docs/site/reference.md Outdated Show resolved Hide resolved
@alhayward alhayward mentioned this pull request Nov 27, 2024
9 tasks
@cbrinson-rise8
Copy link
Collaborator

Looks great!

@alhayward alhayward merged commit e15af3e into main Nov 27, 2024
12 checks passed
@alhayward alhayward deleted the style/rename-matchers branch November 27, 2024 16:21
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.

Adjust matching function names to better represent functionality
3 participants