10BC0 [MRG] DOC Increases search results for API object results (#15574) · scikit-learn/scikit-learn@b1a3367 · GitHub
[go: up one dir, main page]

Skip to content

Commit b1a3367

Browse files
thomasjpfanjnothman
authored andcommitted
[MRG] DOC Increases search results for API object results (#15574)
1 parent 7c58c20 commit b1a3367

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

doc/themes/scikit-learn-modern/static/js/searchtools.js

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111
* - Removes ajax call to get context for each result
1212
* - Adjusts Search.query to remove duplicates in search results.
1313
* - Adjusts Scorer to rank objects higher.
14-
* - Adds Search._total_results to limit the number of search results.
14+
* - Adds Search._total_non_object_results to limit the number of search non
15+
* object results. Object results do not perform another GET resquest, so they
16+
* are cheap to display.
1517
*/
1618

1719
if (!Scorer) {
@@ -63,10 +65,10 @@ var Search = {
6365
_index: null,
6466
_queued_query: null,
6567
_pulse_status: -1,
66-
_total_results: 10,
68+
_total_non_object_results: 10,
6769

6870
htmlToText: function (htmlString) {
69-
var htmlString = htmlString.replace(/<img.+?>/g, "");
71+
var htmlString = htmlString.replace(/<img[\s\S]+?>/g, "");
7072
var htmlElement = document.createElement("span");
7173
htmlElement.innerHTML = htmlString;
7274
$(htmlElement)
@@ -218,22 +220,23 @@ var Search = {
218220
objectterms.slice(i + 1, objectterms.length)
219221
);
220222

221-
if (results.length < this._total_results) {
222-
results = $u.uniq(results.concat(
223-
this.performObjectSearch(objectterms[i], others)
224-
), false, function (item) {return item[1]});
225-
}
223+
results = $u.uniq(results.concat(
224+
this.performObjectSearch(objectterms[i], others)
225+
), false, function (item) {return item[1]});
226226
}
227227

228-
if (results.length < this._total_results) {
229-
// lookup as search terms in fulltext
230-
results = results.concat(
231-
this.performTermsSearch(searchterms, excluded, terms, titleterms)
232-
);
233-
}
228+
var total_object_results = results.length;
229+
230+
// lookup as search terms in fulltext
231+
results = results.concat(
232+
this.performTermsSearch(searchterms, excluded, terms, titleterms)
233+
);
234234

235-
if (results.length > this._total_results) {
236-
results = results.slice(0, this._total_results);
235+
// Only have _total_non_object_results results above the number of
236+
// total number of object results
237+
var results_limit = total_object_results + this._total_non_object_results
238+
if (results.length > results_limit) {
239+
results = results.slice(0, results_limit);
237240
}
238241

239242
// let the scorer override scores with a custom scoring function

0 commit comments

Comments
 (0)
0