package su3 documentation

2022-07-28 15:29:38 -04:00
parent 940347351e
commit 9b81a5c6d8
1 changed files with 5 additions and 0 deletions
--- a/lib/su3/su3.go
+++ b/lib/su3/su3.go
@@ -25,6 +25,11 @@
 //         // Handle error.
 //     }
 //
+// Note: the content io.Reader must be read *before* the signature io.Reader.
+// If you read the signature first, the content bytes will be thrown away.
+// If you then attempt to read the content, you will get an error.
+// For clarification, see TestReadSignatureFirst.
+//
 // PLEASE NOTE: Signature validation is not implemented at this time.
 // Use with caution.
 package su3