fixup commentary

datatrails · Jan 21, 2025 · 23467ab · 23467ab
1 parent 1347ba4
commit 23467ab
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/app/app.go b/app/app.go
@@ -29,7 +29,7 @@ var (
 	ErrNoJsonGiven = errors.New("no json given")
 )
 
-// AppDataToVerifiableLogEntries converts the app data to verifiable log entries
+// AppDataToVerifiableLogEntries converts the app data (one or more app entries) to verifiable log entries
 func AppDataToVerifiableLogEntries(appData []byte, logTenant string) ([]app.AppEntry, error) {
 
 	// first attempt to convert the appdata to a list of events

diff --git a/verifyincluded.go b/verifyincluded.go
@@ -32,6 +32,7 @@ func proofPath(proof [][]byte) string {
 	return fmt.Sprintf("[%s]", strings.Join(hexProof, ", "))
 }
 
+// verifyEvent is an example function of how to verify the inclusion of a datatrails event using the mmr and massifs modules
 func verifyEvent(
 	event *app.AppEntry, logTenant string, mmrEntry []byte, massifHeight uint8, massifGetter MassifGetter,
 ) ([][]byte, error) {