doc: add godoc

Signed-off-by: Sandor Szücs <sandor.szuecs@zalando.de>
This commit is contained in:
Sandor Szücs 2024-01-12 20:53:58 +01:00
parent e5f7e91c0c
commit b8ac272f99
No known key found for this signature in database
GPG Key ID: 2D7B996673E41107

View File

@ -26,8 +26,12 @@ import (
"sigs.k8s.io/external-dns/plan" "sigs.k8s.io/external-dns/plan"
) )
// SoftError is an error, that provider will only log as error instead
// of fatal. It is meant for error propagation from providers to tell
// that this is a transient error.
var SoftError error = errors.New("soft error") var SoftError error = errors.New("soft error")
// NewSoftError creates a SoftError from the given error
func NewSoftError(err error) error { func NewSoftError(err error) error {
return errors.Join(SoftError, err) return errors.Join(SoftError, err)
} }