-
-
Notifications
You must be signed in to change notification settings - Fork 33k
gh-138277: Elevate Built-in Types and Functions in Documentation Search #138278
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
Open
adqm
wants to merge
6
commits into
python:main
Choose a base branch
from
adqm:search_scoring
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
915e580
docs search function: give a boost to built-in types and functions
adqm 2b46b78
rearrange scorer code and add comments
adqm 66b736c
add news entry
adqm 97a8c74
tweak scoring a bit
adqm 7e21628
remove comment about where customization stops
adqm 8da1ff7
move search scorer JS file out of Doc root
adqm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
var Scorer = { | ||
score: function (result) { | ||
let [docname, title, anchor, descr, score, filename] = result; | ||
|
||
// boost the score of built-in functions and types | ||
const builtinPages = ["library/stdtypes", "library/functions"]; | ||
if (builtinPages.includes(docname)) { | ||
score += 7; | ||
} | ||
|
||
return score; | ||
}, | ||
|
||
// all values below this line are the Sphinx defaults | ||
|
||
// Additive scores depending on the priority of the object | ||
// Priority is set by object domains | ||
// (see https://www.sphinx-doc.org/en/master/extdev/domainapi.html) | ||
objPrio: { | ||
skirpichev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
0: 15, | ||
1: 5, | ||
2: -5, | ||
}, | ||
objPrioDefault: 0, | ||
|
||
objNameMatch: 11, // score if object's name exactly matches search query | ||
objPartialMatch: 6, // score if object's name contains search query | ||
|
||
title: 15, // score if title exactly matches search query | ||
partialTitle: 7, // score if title contains search query | ||
|
||
term: 5, // score if a term exactly matches search query | ||
partialTerm: 2, // score if a term contains search query | ||
}; |
2 changes: 2 additions & 0 deletions
2
Misc/NEWS.d/next/Documentation/2025-08-31-02-28-21.gh-issue-138277.kkORph.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Rearranged documentation search results to emphasize built-in types and | ||
functions. Patch by Adam Hartz. |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.