Update Detectors to use phrase inputs instead of Terms #121
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Why are these changes being introduced: * we were often passing Strings but calling the variable `term` which was misleading as our strings were often phrases that are part of the `Term` object. Aka we were calling `Term.phrase` a `term`. Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/TCO-106 How does this address that need: * Renamed `term` to `phrase` to better reflect it often comes from a `Term.phrase` rather than being the actual `Term` object * Improved some documentation
Why are these changes being introduced: * this normalizes all Citation to work like our other Detectors to take string input rather than Terms for their non-record entry-points Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/TCO-106 How does this address that need: * Reworked relevant methods and documentation (and some tests)
JPrevost
changed the title
matt-bernhardt
approved these changes
Oct 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes (please refer to commit messages for full details):
Developer
Ticket(s)
https://mitlibraries.atlassian.net/browse/TCO-106
Accessibility
all issues introduced by these changes have been resolved or opened
as new issues (link to those issues in the Pull Request details above)
Documentation
ENV
Stakeholders
Dependencies and migrations
NO dependencies are updated
NO migrations are included
Reviewer
Code
added technical debt.
Documentation
(not just this pull request message).
Testing