about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2021-04-18 11:42:51 +0000
committerbors <bors@rust-lang.org>2021-04-18 11:42:51 +0000
commitb021beeb6021d8885dc3f21e75a7f56502849633 (patch)
tree45e709aa858194294334b1559604992d4fe417f8
parentd7c338641466d54bf8d4b2eae5d6865483e1d3f4 (diff)
parent37b289720d5913dc2b53debb3a566d42062bdfb3 (diff)
Auto merge of #84285 - hi-rustin:rustin-patch-search, r=GuillaumeGomez
Fix the wrong return value type description of validateResult

It's should be boolean not [boolean].
-rw-r--r--src/librustdoc/html/static/search.js2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/librustdoc/html/static/search.js b/src/librustdoc/html/static/search.js
index 538c811c710..eb232a96081 100644
--- a/src/librustdoc/html/static/search.js
+++ b/src/librustdoc/html/static/search.js
@@ -840,7 +840,7 @@ window.initSearch = function(rawSearchIndex) {
      * @param  {[string]} path   [The path of the result]
      * @param  {[string]} keys   [The keys to be used (["file", "open"])]
      * @param  {[object]} parent [The parent of the result]
-     * @return {[boolean]}       [Whether the result is valid or not]
+     * @return {boolean}       [Whether the result is valid or not]
      */
     function validateResult(name, path, keys, parent) {
         for (var i = 0, len = keys.length; i < len; ++i) {