docs: document trusted header in Verify

celestiaorg · May 27, 2024 · a9164e3 · a9164e3
1 parent 9979590
commit a9164e3
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/verify.go b/verify.go
@@ -11,8 +11,9 @@ import (
 const DefaultHeightThreshold uint64 = 80000 // ~ 14 days of 15 second headers
 
 // Verify verifies untrusted Header against trusted following general Header checks and
-// custom user-specific checks defined in Header.Verify
+// custom user-specific checks defined in Header.Verify.
 //
+// If trusted header is zero, no error is returned.
 // If heightThreshold is zero, uses DefaultHeightThreshold.
 // Always returns VerifyError.
 func Verify[H Header[H]](trstd, untrstd H, heightThreshold uint64) error {