Skip to content

Commit

Permalink
fix doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinWeindel committed Mar 21, 2024
1 parent edb7087 commit 7023890
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions pkg/apis/cert/v1alpha1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ type IssuerRef struct {
Namespace string `json:"namespace,omitempty"`
}

// PrivateKeyAlgorithm is the type for the algorithm
// PrivateKeyAlgorithm is the type for the algorithm.
// +kubebuilder:validation:Enum=RSA;ECDSA
type PrivateKeyAlgorithm string

Expand All @@ -108,7 +108,7 @@ const (
ECDSAKeyAlgorithm PrivateKeyAlgorithm = "ECDSA"
)

// PrivateKeySize is the size for the algorithm
// PrivateKeySize is the size for the algorithm.
// +kubebuilder:validation:Enum=256;384;2048;3072;4096
type PrivateKeySize int32

Expand Down Expand Up @@ -202,7 +202,7 @@ type QualifiedIssuerRef struct {
Namespace string `json:"namespace"`
}

// IsDefaultCluster returns true if the reference is on the default cluster
// IsDefaultCluster returns true if the reference is on the default cluster.
func (r QualifiedIssuerRef) IsDefaultCluster() bool {
return r.Cluster == "default"
}
Expand Down
6 changes: 3 additions & 3 deletions pkg/cert/legobridge/certificate.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ func obtainForDomains(client *lego.Client, domains []string, input ObtainInput)
return client.Certificate.Obtain(request)
}

// ToKeyType extracts the key type from the
// ToKeyType extracts the key type from the private key spec.
func ToKeyType(privateKeySpec *api.CertificatePrivateKey) (certcrypto.KeyType, error) {
keyType := certcrypto.RSA2048
if privateKeySpec != nil {
Expand Down Expand Up @@ -189,7 +189,7 @@ func ToKeyType(privateKeySpec *api.CertificatePrivateKey) (certcrypto.KeyType, e
return keyType, nil
}

// FromKeyType converts key type back to
// FromKeyType converts key type back to a private key spec.
func FromKeyType(keyType certcrypto.KeyType) *api.CertificatePrivateKey {
switch keyType {
case certcrypto.RSA2048:
Expand Down Expand Up @@ -270,7 +270,7 @@ func (o *obtainer) Obtain(input ObtainInput) error {
}
}

// Obtain starts the async obtain request.
// ObtainACME starts the async obtain request.
func (o *obtainer) ObtainACME(input ObtainInput) error {
err := o.setPending(input)
if err != nil {
Expand Down

0 comments on commit 7023890

Please sign in to comment.