Permalink
Browse files

[docs] dont blame lunr

  • Loading branch information...
1 parent fd5cf7d commit 97d66f7bc3cfa4f9905699d7f0e064437f93df2c @Swaagie Swaagie committed Mar 13, 2013
Showing with 5 additions and 5 deletions.
  1. +5 −5 index.js
View
@@ -251,11 +251,11 @@ function prepareSearch(toc) {
//
// ### function Handbook()
-// Constructor for easy access to Handbook content.
+// Constructor for easy access to Handbook content. On constructuing handbook
+// synchronously prepare the search index. Listening to a search index ready
+// event is not required thus easing the flow.
//
function Handbook() {
- // On constructuing handbook synchronously prepare the search index. Listening
- // to a search index ready event is not required thus easing the flow.
prepareSearch(walkSync(loc));
}
@@ -285,8 +285,8 @@ Handbook.prototype.catalog = function catalog(callback) {
//
// ### function search()
// #### @query {String} Query to search against
-// Proxy to the search method of Lunr, returns a list of documents, due to Lunr
-// this must be called on scope of Lunr.
+// Proxy to the search method of Lunr, returns a list of documents, this must
+// be called in Lunr scope.
//
Handbook.prototype.search = function (query) {
return idx.search.call(idx, query);

0 comments on commit 97d66f7

Please sign in to comment.