Document the file containing both functions

chrislo · chrislo · commit 0bcbf895a3b7 · 2014-05-20T19:01:29.000+01:00
diff --git a/cachematrix.R b/cachematrix.R
@@ -1,5 +1,8 @@
-## Put comments here that give an overall description of what your
-## functions do
+# Calculating the inverse of a matrix can be computationally
+# costly. The function makeCacheMatrix is a special data structure
+# which stores a matrix x and its inverse. cacheSolve calculates the
+# inverse of the matrix stored in this data structure, but returns the
+# value in the cache if the inverse has already been calculated.
 
 makeCacheMatrix <- function(x = matrix()) {
     # Creates a data structure which caches the inverse of the matrix
