add comments for functions

Author: nkubala

cmd/diff.go

@@ -70,6 +70,7 @@ func checkFilenameFlag(_ []string) error {
 	return errors.New("please include --types=file with the --filename flag")
 }
 
+// processImage is a concurrency-friendly wrapper around getImageForName
 func processImage(imageName string, imageMap map[string]*pkgutil.Image, wg *sync.WaitGroup, errChan chan<- error) {
 	defer wg.Done()
 	image, err := getImageForName(imageName)

cmd/root.go

@@ -132,6 +132,9 @@ func checkIfValidAnalyzer(_ []string) error {
 	return nil
 }
 
+// getImageForName infers the source of an image and retrieves a v1.Image reference to it.
+// Once a reference is obtained, it attempts to unpack the v1.Image's reader's contents
+// into a temp directory on the local filesystem.
 func getImageForName(imageName string) (pkgutil.Image, error) {
 	logrus.Infof("retrieving image: %s", imageName)
 	var img v1.Image