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] JavaScript refactor: extract subcomponents from Search.query function. #12229

Merged

Conversation

jayaddison
Copy link
Contributor

@jayaddison jayaddison commented Apr 4, 2024

Feature or Bugfix

  • Refactoring

Purpose

  • Refactor the searchtools.js code to make it more unit-testable.

Detail

  • The JavaScript Search.query method intertwines display-related logic with search-related logic. In particular during unit testing, we want to test the latter without needing to mock out / stub the former -- so this changeset extracts subcomponents from query that can be unit-tested individually.

Relates

@picnixz
Copy link
Member

picnixz commented Apr 5, 2024

Thank you!

@picnixz picnixz merged commit 4b7a2c3 into sphinx-doc:master Apr 5, 2024
23 checks passed
@jayaddison jayaddison deleted the issue-12099-prep/refactor-js-search-code branch April 5, 2024 14:54
@jayaddison
Copy link
Contributor Author

Thank you!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 6, 2024
@AA-Turner AA-Turner added this to the 7.3.0 milestone Jul 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
html search internals:refactoring javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants