Skip to content

Commit 158184e

Browse files
docs(notation): remove mention of NotationOptions and cleanup
Signed-off-by: Jason <jagoodse@microsoft.com>
1 parent 53c737b commit 158184e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

internal/oci/notation/notation.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ func WithTrustStore(trustStore *trustpolicy.Document) Options {
7474
}
7575
}
7676

77-
// WithRootCertificate is a function that creates a NotationOptions function option
78-
// to set the root CA certificate for notary.
79-
// It takes in the certificate data as a byte slice and the name of the certificate.
80-
// The function returns a NotationOptions function option that sets the public certificate
77+
// WithRootCertificate is a functional option for overriding the default
78+
// rootCertificate options used by the verifier to set the root CA certificate for notary.
79+
// It takes in the certificate data as a byte slice.
80+
// The function returns a options function option that sets the public certificate
8181
// in the notation options.
8282
func WithRootCertificate(data []byte) Options {
8383
return func(opts *options) {
@@ -94,15 +94,15 @@ func WithRemoteOptions(opts ...remote.Option) Options {
9494
}
9595

9696
// WithAuth is a functional option for overriding the default
97-
// remote options used by the verifier
97+
// authenticator options used by the verifier
9898
func WithAuth(auth authn.Authenticator) Options {
9999
return func(o *options) {
100100
o.auth = auth
101101
}
102102
}
103103

104104
// WithKeychain is a functional option for overriding the default
105-
// remote options used by the verifier
105+
// keychain options used by the verifier
106106
func WithKeychain(key authn.Keychain) Options {
107107
return func(o *options) {
108108
o.keychain = key

0 commit comments

Comments
 (0)