typos

qualiancy · Nov 18, 2012 · 3b7cd8d · 3b7cd8d
1 parent d6aaf25
commit 3b7cd8d
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -133,7 +133,7 @@ indicate if the data at that index passed the query criteria.
 ```js
 var query = { $or : [ { 'hello': true }, { 'universe': true } ] }
   , q = filter(query)
-  , results= q.pass([
+  , result = q.pass([
         { hello: true }
       , { universe: false }
       , { hello: false, universe: true }
@@ -144,11 +144,11 @@ result.should
   .be.an('array')
   .and.have.length(4)
   .and.deep.equal([
-     true
-   , false
-   , true
-   , false
- ]);
+      true
+    , false
+    , true
+    , false
+  ]);
 ```
 
 
@@ -182,10 +182,10 @@ result.should
 
 The following are the comparators implemented
 for use as part of a query. They can also be used
-for simple comparation, such as `filter.$eq(2,2)` which
-would return `true`.
+for simple comparation, such as `filter.comparators.$eq(2,2)`,
+which would return `true`.
 
-#### .$gt (a, b)
+##### $gt (a, b)
 
 * **@param** _{Number}_ a 
 * **@param** _{Number}_ b 
@@ -194,7 +194,7 @@ would return `true`.
 Assert `a` is greater than `b`.
 
 
-#### .$gte (a, b)
+##### $gte (a, b)
 
 * **@param** _{Number}_ a 
 * **@param** _{Number}_ b 
@@ -203,7 +203,7 @@ Assert `a` is greater than `b`.
 Assert `a` is greater than or equal to `b`.
 
 
-#### .$lt (a, b)
+##### $lt (a, b)
 
 * **@param** _{Number}_ a 
 * **@param** _{Number}_ b 
@@ -212,7 +212,7 @@ Assert `a` is greater than or equal to `b`.
 Assert `a` is less than `b`.
 
 
-#### .$lte (a, b)
+##### $lte (a, b)
 
 * **@param** _{Number}_ a 
 * **@param** _{Number}_ b 
@@ -221,7 +221,7 @@ Assert `a` is less than `b`.
 Assert `a` is less than or equal to `b`.
 
 
-#### .$all (a, b)
+##### $all (a, b)
 
 * **@param** _{Array}_ a 
 * **@param** _{Array}_ b 
@@ -230,7 +230,7 @@ Assert `a` is less than or equal to `b`.
 Assert `a` contains at least all items in `b`.
 
 
-#### .$exists (a, b)
+##### $exists (a, b)
 
 * **@param** _{Mixed}_ a 
 * **@param** _{Boolean}_ b 
@@ -239,7 +239,7 @@ Assert `a` contains at least all items in `b`.
 Assert truthiness of `a` equals `b`.
 
 
-#### .$mod (a, b)
+##### $mod (a, b)
 
 * **@param** _{Number}_ a 
 * **@param** _{Array}_ b 
@@ -248,7 +248,7 @@ Assert truthiness of `a` equals `b`.
 Assert `a` mod (`%`) `b[0]` equals `b[1]`.
 
 
-#### .$eq (a, b)
+##### $eq (a, b)
 
 * **@param** _{Mixed}_ a 
 * **@param** _{Mixed}_ b 
@@ -257,7 +257,7 @@ Assert `a` mod (`%`) `b[0]` equals `b[1]`.
 Assert `a` equals (`===`) `b`.
 
 
-#### .$eq (a, b)
+##### $eq (a, b)
 
 * **@param** _{Mixed}_ a 
 * **@param** _{Mixed}_ b 
@@ -266,7 +266,7 @@ Assert `a` equals (`===`) `b`.
 Assert `a` does not equal (`!==`) `b`.
 
 
-#### .$in (a, b)
+##### $in (a, b)
 
 * **@param** _{Mixed}_ a 
 * **@param** _{Array}_ b 
@@ -275,7 +275,7 @@ Assert `a` does not equal (`!==`) `b`.
 Assert `a` is in `b` using `indexOf`.
 
 
-#### .$nin (a, b)
+##### $nin (a, b)
 
 * **@param** _{Mixed}_ a 
 * **@param** _{Array}_ b 
@@ -284,7 +284,7 @@ Assert `a` is in `b` using `indexOf`.
 Assert `a` is not in `b` using `indexOf`.
 
 
-#### .$size (a, b)
+##### $size (a, b)
 
 * **@param** _{Mixed}_ a 
 * **@param** _{Number}_ b 
@@ -295,31 +295,29 @@ Assert `a` has length of `b`. Returns
 property.
 
 
-#### .$or (a)
+##### $or (a)
 
 * **@param** _{Array}_ a 
 * **@return** _{Boolean}_  
 
 Assert `a` has at least one truthy value.
 
 
-#### .$nor (a)
+##### $nor (a)
 
 * **@param** _{Array}_ a 
 * **@return** _{Boolean}_  
 
 Assert `a` has zero truthy values.
 
 
-#### .$and (a)
+##### $and (a)
 
 * **@param** _{Array}_ a 
 * **@return** _{Boolean}_  
 
 Assert `a` has all truthy values.
 
-
-
 ## License
 
 (The MIT License)

diff --git a/lib/filter.js b/lib/filter.js
@@ -168,7 +168,7 @@ Filter.prototype.subset = function (data) {
  * ```js
  * var query = { $or : [ { 'hello': true }, { 'universe': true } ] }
  *   , q = filter(query)
- *   , results= q.pass([
+ *   , result = q.pass([
  *         { hello: true }
  *       , { universe: false }
  *       , { hello: false, universe: true }
@@ -179,11 +179,11 @@ Filter.prototype.subset = function (data) {
  *   .be.an('array')
  *   .and.have.length(4)
  *   .and.deep.equal([
- *      true
- *    , false
- *    , true
- *    , false
- *  ]);
+ *       true
+ *     , false
+ *     , true
+ *     , false
+ *   ]);
  * ```
  *
  * @param {Array} data
@@ -246,14 +246,14 @@ Filter.prototype.index = function (data) {
  *
  * The following are the comparators implemented
  * for use as part of a query. They can also be used
- * for simple comparation, such as `filter.$eq(2,2)` which
- * would return `true`.
+ * for simple comparation, such as `filter.comparators.$eq(2,2)`,
+ * which would return `true`.
  */
 
 Filter.comparators = {
 
     /**
-     * #### .$gt (a, b)
+     * ##### $gt (a, b)
      *
      * Assert `a` is greater than `b`.
      *
@@ -268,7 +268,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$gte (a, b)
+     * ##### $gte (a, b)
      *
      * Assert `a` is greater than or equal to `b`.
      *
@@ -283,7 +283,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$lt (a, b)
+     * ##### $lt (a, b)
      *
      * Assert `a` is less than `b`.
      *
@@ -298,7 +298,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$lte (a, b)
+     * ##### $lte (a, b)
      *
      * Assert `a` is less than or equal to `b`.
      *
@@ -313,7 +313,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$all (a, b)
+     * ##### $all (a, b)
      *
      * Assert `a` contains at least all items in `b`.
      *
@@ -331,7 +331,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$exists (a, b)
+     * ##### $exists (a, b)
      *
      * Assert truthiness of `a` equals `b`.
      *
@@ -346,7 +346,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$mod (a, b)
+     * ##### $mod (a, b)
      *
      * Assert `a` mod (`%`) `b[0]` equals `b[1]`.
      *
@@ -361,7 +361,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$eq (a, b)
+     * ##### $eq (a, b)
      *
      * Assert `a` equals (`===`) `b`.
      *
@@ -376,7 +376,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$eq (a, b)
+     * ##### $eq (a, b)
      *
      * Assert `a` does not equal (`!==`) `b`.
      *
@@ -391,7 +391,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$in (a, b)
+     * ##### $in (a, b)
      *
      * Assert `a` is in `b` using `indexOf`.
      *
@@ -406,7 +406,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$nin (a, b)
+     * ##### $nin (a, b)
      *
      * Assert `a` is not in `b` using `indexOf`.
      *
@@ -421,7 +421,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$size (a, b)
+     * ##### $size (a, b)
      *
      * Assert `a` has length of `b`. Returns
      * `false` if `a` does not have a length.
@@ -438,7 +438,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$or (a)
+     * ##### $or (a)
      *
      * Assert `a` has at least one truthy value.
      *
@@ -457,7 +457,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$nor (a)
+     * ##### $nor (a)
      *
      * Assert `a` has zero truthy values.
      *
@@ -476,7 +476,7 @@ Filter.comparators = {
     }
 
     /**
-     * #### .$and (a)
+     * ##### $and (a)
      *
      * Assert `a` has all truthy values.
      *