From 70e9f8c9b46f2c83cd59cd45093208cc424c74c7 Mon Sep 17 00:00:00 2001 From: Rob Hoelz Date: Sun, 3 Jun 2018 07:18:38 -0500 Subject: [PATCH] Add link to scoring guide in search jsdoc --- lib/index.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/index.js b/lib/index.js index 0a30fa21..b7468b6a 100644 --- a/lib/index.js +++ b/lib/index.js @@ -89,7 +89,8 @@ lunr.Index = function (attrs) { * Performs a search against the index using lunr query syntax. * * Results will be returned sorted by their score, the most relevant results - * will be returned first. + * will be returned first. For details on how the score is calculated, please see + * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}. * * For more programmatic querying use lunr.Index#query. *