Better method doc.

Signed-off-by: Jeff Ortel <[email protected]>

api/analysis.go

@@ -2871,6 +2871,16 @@ func (r *yamlEncoder) embed(object any) encoder {
 }
 
 // ManifestReader analysis manifest reader.
+// The manifest contains 3 sections containing documents delimited by markers.
+// The manifest must contain ALL markers even when sections are empty.
+// Note: `^]` = `\x1D` = GS (group separator).
+// Section markers:
+//   ^]BEGIN-MAIN^]
+//   ^]END-MAIN^]
+//   ^]BEGIN-ISSUES^]
+//   ^]END-ISSUES^]
+//   ^]BEGIN-DEPS^]
+//   ^]END-DEPS^]
 type ManifestReader struct {
 	file   *os.File
 	marker map[string]int64

binding/application.go

@@ -313,10 +313,10 @@ type Analysis struct {
 }
 
 // Create an analysis report using the manifest at the specified path.
-// The manifest contains 3 sections containing documents delimited by separators.
-// The manifest must contain ALL delimiters even when sections are empty.
-// Note: `^]` = `\x1D` = GS (group separator character).
-// Section separators:
+// The manifest contains 3 sections containing documents delimited by markers.
+// The manifest must contain ALL markers even when sections are empty.
+// Note: `^]` = `\x1D` = GS (group separator).
+// Section markers:
 //   ^]BEGIN-MAIN^]
 //   ^]END-MAIN^]
 //   ^]BEGIN-ISSUES^]