Improved search and its docs #193
Open
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
If index is not matched, hits will include items that might match the type, but are from irrelevant sections. For example searching for a song will include lyrics matches, but those are irrelevant
- Make clear that search_album, search_artist and search_song are convenience methods - Improve docs of type_id parameter
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.
_get_item_from_search_responseincludes all items in thehitslist as long as their type matches. But this can lead to false matches. For example, the user could be searching for a song. The method would include songs that have similarities in their lyrics to the search term. But what we actually want is songs that have a similar title. So now the method takes theindexkey into account as well.search_album,search_artistandsearch_songmethods that they're only convenience methods and the user can do what the method does themselves.type_id (e.g.song_id`) parameter in the convenience methods.