Boost title-matching scores if main title #12393
Closed
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
Related to sphinx-doc#12391. Intended as a proof of concept, not a full solution.
|
Before: |
wlach
commented
May 25, 2024
| @@ -328,10 +328,14 @@ const Search = { | |||
| for (const [title, foundTitles] of Object.entries(allTitles)) { | |||
| if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { | |||
| for (const [file, id] of foundTitles) { | |||
| let score = Math.round(100 * queryLower.length / title.length) | |||
There was a problem hiding this comment.
100 appears to be a total magic number AFAICT
wlach
commented
May 25, 2024
| // score these a little bit above document matches, with more of a boost | ||
| // for main document titles | ||
| let baseScore = Scorer.title + (isMainTitle ? 2 : 1) | ||
| let score = Math.round(baseScore * queryLower.length / title.length) |
There was a problem hiding this comment.
Suggested change
| let score = Math.round(baseScore * queryLower.length / title.length) | |
| let baseScore = (isMainTitle ? Scorer.title : Scorer.partialTitle) + 1 |
Got more relevant results by doing the above, but it feels even more hacky. Also comes at the cost of pushing subtitle matches even further down.
jayaddison
added
html search
javascript
4 tasks
|
I've rolled this into the test coverage added by #12441, and it allows those tests to pass (with one small unrelated test failure that occurred due to a score-change on an existing test), and then applied some adjustments/refactoring - let me know what you think! |
|
#12441 looks good! Let's close this in favour of that, this was only intended as a prototype. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Feature or Bugfix
Purpose
Trying to make sure that title matches don't get unnecessary prominence. Intended as a proof of concept, not a full solution.
Detail
TBD
Relates