Merge pull request #10 from luhring/small-docs-fixes

Minor fixes to doc comments

Author: luhring

pkg/csaf/csaf.go

@@ -71,7 +71,7 @@ func (branch *ProductBranch) FindFirstProduct() string {
 		return branch.Product.ID
 	}
 
-	// No noested branches
+	// No nested branches
 	if branch.Branches == nil {
 		return ""
 	}
@@ -85,7 +85,7 @@ func (branch *ProductBranch) FindFirstProduct() string {
 	return ""
 }
 
-// FindFirstProduct recursively searches for the first product in the tree
+// FindProductIdentifier recursively searches for the first product identifier in the tree
 func (branch *ProductBranch) FindProductIdentifier(helperType, helperValue string) *Product {
 	if len(branch.Product.IdentificationHelper) != 0 {
 		for k := range branch.Product.IdentificationHelper {
@@ -98,7 +98,7 @@ func (branch *ProductBranch) FindProductIdentifier(helperType, helperValue strin
 		}
 	}
 
-	// No noested branches
+	// No nested branches
 	if branch.Branches == nil {
 		return nil
 	}

pkg/vex/statement.go

@@ -12,7 +12,9 @@ import (
 	"time"
 )
 
-// A Statement is a declaration conveying a single [status] for a single [vul_id] for one or more [product_id]s. A VEX Statement exists within a VEX Document.
+// A Statement is a declaration conveying a single [status] for a single
+// [vul_id] for one or more [product_id]s. A VEX Statement exists within a VEX
+// Document.
 type Statement struct {
 	// [vul_id] SHOULD use existing and well known identifiers, for example:
 	// CVE, the Global Security Database (GSD), or a supplier’s vulnerability

pkg/vex/vex.go

@@ -322,8 +322,11 @@ func (vexDoc *VEX) GenerateCanonicalID() (string, error) {
 	return vexDoc.ID, nil
 }
 
+// DateFromEnv returns a time object representing the time specified in the
+// `SOURCE_DATE_EPOCH` environment variable, whose value can be specified as
+// either UNIX seconds or as a RFC3339 value.
 func DateFromEnv() (*time.Time, error) {
-	// Support envvar for reproducible vexing
+	// Support env var for reproducible vexing
 	d := os.Getenv("SOURCE_DATE_EPOCH")
 	if d == "" {
 		return nil, nil
@@ -336,7 +339,7 @@ func DateFromEnv() (*time.Time, error) {
 	} else {
 		t, err = time.Parse(time.RFC3339, d)
 		if err != nil {
-			return nil, fmt.Errorf("failed to parse envvar SOURCE_DATE_EPOCH: %w", err)
+			return nil, fmt.Errorf("failed to parse env var SOURCE_DATE_EPOCH: %w", err)
 		}
 	}
 	return &t, nil