Document cacheSolve

chrislo · chrislo · commit 514c8ea3ae46 · 2014-05-20T18:59:05.000+01:00
diff --git a/cachematrix.R b/cachematrix.R
@@ -30,8 +30,17 @@ makeCacheMatrix <- function(x = matrix()) {
          getinverse = getinverse)
 }
 
-## Write a short comment describing this function
 cacheSolve <- function(x) {
+    # return the inverse of x, where x is a cachable data structure
+    # created with makeCacheMatrix. If the matrix hasn't changed the
+    # result is returned from the cache
+    #
+    # Args:
+    #   x: an instance of makeCacheMatrix containing the matrix to be
+    #   inverted.
+    #
+    # Returns:
+    #   The inverse of the matrix (calculated using solve())
 
     xinverse <- x$getinverse()
     if(!is.null(xinverse)) {
