deprecate catalogue-matching functions#133
Open
SaInekK wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
Per your comment on #132:
This PR does step 1 — adds a
DeprecationWarningand a.. deprecated::docstring note to the three public catalogue entry points insrc/harmony/matching/matcher.py:match_instruments_with_catalogue_instrumentsmatch_questions_with_catalogue_instrumentsmatch_query_with_catalogue_instrumentsThe warning message points users to https://harmonydata.ac.uk/search. No behaviour change — existing callers continue to work.
A small test file (
tests/test_catalogue_deprecation_warnings.py) pins that each entry point emits aDeprecationWarningwhose message mentions Weaviate, so the deprecation cannot silently disappear later.Removal of the functions themselves is left for a follow-up PR (next major version).