fix comments to reduce golint issues

Signed-off-by: DiptoChakrabarty <diptochuck123@gmail.com>
This commit is contained in:
DiptoChakrabarty 2022-02-16 17:27:40 +05:30
parent 10c5d72279
commit ee069f2c45
3 changed files with 6 additions and 6 deletions

View File

@ -24,8 +24,8 @@ import (
"k8s.io/cli-runtime/pkg/resource"
)
// Create CRDs. Before calling this function, we made sure that the CRDs
// are not yet installed on the cluster.
// CreateCRDs creates cert manager CRDs. Before calling this function, we
// made sure that the CRDs are not yet installed on the cluster.
func CreateCRDs(allCRDs []*resource.Info, cfg *action.Configuration) error {
log.Printf("Creating the cert-manager CRDs")
// Create all CRDs

View File

@ -28,7 +28,7 @@ import (
// TODO: Unexport?
const CloudFlareAPIURL = "https://api.cloudflare.com/client/v4"
// Mockable Interface
// DNSProviderType is the Mockable Interface
type DNSProviderType interface {
makeRequest(method, uri string, body io.Reader) (json.RawMessage, error)
}
@ -91,7 +91,7 @@ func NewDNSProviderCredentials(email, key, token string, dns01Nameservers []stri
}, nil
}
// This will try to traverse the official Cloudflare API to find the nearest valid Zone.
// FindNearestZoneForFQDN will try to traverse the official Cloudflare API to find the nearest valid Zone.
// It's a replacement for /pkg/issuer/acme/dns/util/wait.go#FindZoneByFqdn
// example.com. ← Zone-Record found for the SLD (in most cases)
// └── foo.example.com. ← Zone-Record could be possibly here, but in this case not.

View File

@ -25,7 +25,7 @@ import (
"github.com/cert-manager/cert-manager/pkg/controller"
)
// issuerConstructor constructs an issuer given an Issuer resource and a Context.
// IssuerConstructor constructs an issuer given an Issuer resource and a Context.
// An error will be returned if the appropriate issuer is not registered.
type IssuerConstructor func(*controller.Context, v1.GenericIssuer) (Interface, error)
@ -34,7 +34,7 @@ var (
constructorsLock sync.RWMutex
)
// Register will register an issuer constructor so it can be used within the
// RegisterIssuer will register an issuer constructor so it can be used within the
// application. 'name' should be unique, and should be used to identify this
// issuer.
// TODO: move this method to be on Factory, and invent a way to obtain a