Update comment on DeleteFiles method

gruntwork-io · Feb 1, 2017 · 931215d · 931215d
1 parent 15ed21e
commit 931215d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/util/file.go b/util/file.go
@@ -46,7 +46,8 @@ func CanonicalPaths(paths []string, basePath string) ([]string, error) {
 	return canonicalPaths, nil
 }
 
-// Delete the given list of files
+// Delete the given list of files. Note: this function ONLY deletes files and will return an error if you pass in a
+// folder path.
 func DeleteFiles(files []string) error {
 	for _, file := range files {
 		if err := os.Remove(file); err != nil {