Skip to content

Add AlgorithmPass label and description fields#272

Merged
ericbuckley merged 5 commits into
mainfrom
feature/pass-label-description
Apr 7, 2025
Merged

Add AlgorithmPass label and description fields#272
ericbuckley merged 5 commits into
mainfrom
feature/pass-label-description

Conversation

@ericbuckley

@ericbuckley ericbuckley commented Mar 31, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Description

Add label and description fields to Algorithm Pass to assist users in identifying which pass they are viewing/editing.

Related Issues

closes #246

Additional Notes

Both of these fields are optional, in the event that a label isn't specified we'll default to a value that is based on the evaluators used. This wasn't specified in the spec, but I thought it be nice to auto generate some labels for users. I believe Henry was doing something similar in the mockups he put together for NBS.

<--------------------- 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.

@ericbuckley ericbuckley self-assigned this Mar 31, 2025
@codecov

codecov Bot commented Mar 31, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.94%. Comparing base (cfa718e) to head (1b35621).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #272      +/-   ##
==========================================
+ Coverage   97.92%   97.94%   +0.01%     
==========================================
  Files          33       33              
  Lines        1787     1804      +17     
==========================================
+ Hits         1750     1767      +17     
  Misses         37       37

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ericbuckley ericbuckley marked this pull request as ready for review March 31, 2025 23:03
ericbuckley
ericbuckley commented Mar 31, 2025
View reviewed changes
Comment thread src/recordlinker/schemas/algorithm.py Outdated
m-goggins
m-goggins reviewed Apr 1, 2025
View reviewed changes

@m-goggins m-goggins left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good to me! Just left one small comment about default to include blocking values.

Comment thread src/recordlinker/schemas/algorithm.py Outdated
@m-goggins m-goggins self-requested a review April 2, 2025 21:31
m-goggins
m-goggins previously approved these changes Apr 2, 2025
View reviewed changes
bamader
bamader previously approved these changes Apr 3, 2025
View reviewed changes

@bamader bamader left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Left some thoughts on the default name, but don't want that to obstruct anything so giving my +1

Comment thread src/recordlinker/schemas/algorithm.py Outdated
@ericbuckley ericbuckley dismissed stale reviews from m-goggins and bamader via e6d9c84 April 7, 2025 18:37
m-goggins
m-goggins previously approved these changes Apr 7, 2025
View reviewed changes

@m-goggins m-goggins left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good, just want to make sure the initial algorithms match the defaults! Thanks for making the changes; I like Brandon's suggestion to make it easier to read while still capturing the information for users.

Comment thread src/recordlinker/assets/initial_algorithms.json Outdated
Comment thread src/recordlinker/assets/initial_algorithms.json Outdated
@m-goggins m-goggins self-requested a review April 7, 2025 20:39
m-goggins
m-goggins approved these changes Apr 7, 2025
View reviewed changes

@m-goggins m-goggins left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🚀

@ericbuckley ericbuckley merged commit ab93ddc into main Apr 7, 2025
@ericbuckley ericbuckley deleted the feature/pass-label-description branch April 7, 2025 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@m-goggins m-goggins m-goggins approved these changes

@bamader bamader bamader left review comments

Assignees

@ericbuckley ericbuckley

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Algorithm Pass label and description

3 participants

@ericbuckley @bamader @m-goggins