reformatted comments

blainewishart · blainewishart · commit 4e2bc36e4ffe · 2014-05-24T13:23:35.000-05:00
diff --git a/cachematrix.R b/cachematrix.R
@@ -1,16 +1,19 @@
 # Getting the inverse of a matrix in R is simple, but it may be computationally
 # expensive. If we have a suitable square matrix, one line of R code will
-# do the job, but if we may need to compute the same inverse many times,in a loop
-# for example, it may be useful to cache the inverse. The two functions makeCacheMatrix()
+# do the job, but if we may need to compute the same inverse many times, it may be useful 
+# to cache the inverse. 
+# The two functions makeCacheMatrix()
 # and cacheSolve() work together to cache a the matrix and its inverse so that the computation
-# only needs to be done once. See individual functions for implementation details.
+# only needs to be done once. See individual functions for implementation details and a 
+# transcript of their use at the end of this file.
 
 ## makeCacheMatrix
-#      initialize a matrix and an intial value of its inverse. The matix may be empty. 
-#      the inverse will be null
-
-# include functions to get/set matrix and get/set its inverse
-
+#     Initialize a matrix and an intial value of its inverse. The matix may be empty. 
+#     tThe inverse will be null
+#     dDefine functions to get/set matrix and get/set its inverse
+#     The return value will be a list of data and functions.
+#     Taken together these functions and data use R's functional features
+#     to create an 'object'
 makeCacheMatrix <- function(x = matrix()) {
   i <- NULL
   set <- function(y) {
@@ -25,17 +28,17 @@ makeCacheMatrix <- function(x = matrix()) {
        getInverse = getInverse)
 }
 ## cacheSolve
-#       get the inverse of the cached matrix 
-#    if it is NULL, compute the inverse
-#    if it is not NULL, return the cached value
+#   Get the inverse of the cached matrix 
+#   If it is NULL, compute the inverse
+#   If it is not NULL, return the cached value
 cacheSolve <- function(x, ...) {
   i <- x$getInverse()
   if(!is.null(i)) {   #if the inverse is not NULL, use cached value
     message("getting cached data")
     return(i)
   }
-  data <- x$get()  #the inverse was NULL. Get the matrix
-  i <- solve(data) # recompute matrix inverse
-  x$setInverse(i)  # cache the inverse
-  i               # return the inverse
+  data <- x$get()   # the inverse was NULL. Get the matrix
+  i <- solve(data)  # recompute matrix inverse
+  x$setInverse(i)   # cache the inverse
+  i                 # return the inverse
 }
