Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

search: fix cases where .suggest gets only one item back #2513

Merged
merged 2 commits into from
Oct 6, 2023

Conversation

dgw
Copy link
Member

@dgw dgw commented Oct 1, 2023

xmltodict presents a response with only one <CompleteSuggestion> element as just a plain OrderedDict, without any list wrapping it. This PR fixes the behavior, adds an @example test covering a query that currently returns only one result, and updates the VCR cassettes for all @example tests.

As a bonus, which example should appear in .help suggest is now explicitly specified with user_help=True.

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make lint and make test)
    • Same as my last PR, an unrelated error appears in my local make lint run that doesn't appear in our CI.
  • I have tested the functionality of the things this change touches

`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 dgw added Tests Bugfix Generally, PRs that reference (and fix) one or more issue(s) Housekeeping Code cleanup, removal of deprecated stuff, etc. labels Oct 1, 2023
@dgw dgw added this to the 8.0.0 milestone Oct 1, 2023
@dgw dgw requested a review from a team October 1, 2023 22:16
@dgw dgw merged commit df2009e into master Oct 6, 2023
13 checks passed
@dgw dgw deleted the search-suggest-single branch October 6, 2023 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bugfix Generally, PRs that reference (and fix) one or more issue(s) Housekeeping Code cleanup, removal of deprecated stuff, etc. Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants