clarify intention

Khan · Apr 6, 2015 · 6f4b66b · 6f4b66b
1 parent 92454b1
commit 6f4b66b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -144,10 +144,10 @@ is found, `[decimal, 1]` is returned.
 kmath.vector
 ------------
 
-#### `vector.is(maybeAVector, [length])`
+#### `vector.is(maybeAVector, [dimension])`
 
-Returns true if `maybeAVector` is an array of numbers. If length is specified,
-only returns true if `maybeAVector` is a vector of length `length`.
+Returns true if `maybeAVector` is an array of numbers. If `dimension` is specified,
+only returns true if `maybeAVector` is a vector with dimension `dimension`.
 
 #### `vector.equal(v1, v2, [tolerance])`
 

diff --git a/vector.js b/vector.js
@@ -16,11 +16,11 @@ function arrayProduct(array) {
 
 var kvector = {
 
-    is: function(vec, length) {
+    is: function(vec, dimension) {
         if (!_.isArray(vec)) {
             return false;
         }
-        if (length !== undefined && vec.length !== length) {
+        if (dimension !== undefined && vec.length !== dimension) {
             return false;
         }
         return _.all(vec, knumber.is);