doc: add godoc

Signed-off-by: Sandor Szücs <sandor.szuecs@zalando.de>
kubernetes-sigs · Feb 7, 2024 · c48a753 · c48a753
1 parent 125203c
commit c48a753
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/provider/provider.go b/provider/provider.go
@@ -26,8 +26,12 @@ import (
 	"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")
 
+// NewSoftError creates a SoftError from the given error
 func NewSoftError(err error) error {
 	return errors.Join(SoftError, err)
 }