search: fix cases where .suggest gets only one item back
#2513
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
`xmltodict` presents a response with only one `<CompleteSuggestion>` element as just a plain OrderedDict, without any list wrapping it.
Tests now cover a case where the suggestion endpoint returns only one value (`.suggest sopel irc`). The responses for preexisting cases have been updated, too, since I shuffled the order of the examples. Which example to show in `.help suggest` is now explicitly specified using the `user_help` kwarg.
dgw
added
Tests
Bugfix
Exirel
approved these changes
Oct 2, 2023
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.
xmltodictpresents a response with only one<CompleteSuggestion>element as just a plain OrderedDict, without any list wrapping it. This PR fixes the behavior, adds an@exampletest covering a query that currently returns only one result, and updates the VCR cassettes for all@exampletests.As a bonus, which example should appear in
.help suggestis now explicitly specified withuser_help=True.Checklist
make qa(runsmake lintandmake test)make lintrun that doesn't appear in our CI.