nit: add comments to Signer interface (#1228)

Signed-off-by: Jake Sanders <jsand@google.com>
sigstore · Dec 16, 2021 · b2d6393 · b2d6393
1 parent f2e034d
commit b2d6393
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/internal/pkg/cosign/sign.go b/internal/pkg/cosign/sign.go
@@ -22,6 +22,8 @@ import (
 	"github.com/sigstore/cosign/pkg/oci"
 )
 
+// Signer signs payloads in the form of `oci.Signature`s
 type Signer interface {
+	// Sign signs the given payload, returning the results as an `oci.Signature` which can be varified using the returned `crypto.PublicKey`.
 	Sign(ctx context.Context, payload io.Reader) (oci.Signature, crypto.PublicKey, error)
 }