Add link to scoring guide in search jsdoc

olivernn · Jun 5, 2018 · 70e9f8c · 70e9f8c
1 parent fb70cb4
commit 70e9f8c
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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.
  *