doc: add godoc

szuecs · szuecs · commit b8ac272f99a7 · 2024-01-12T20:54:12.000+01:00
Signed-off-by: Sandor Szücs &lt;sandor.szuecs@zalando.de&gt;
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)
 }

Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,12 @@ import (`
`26`	`26`	`"sigs.k8s.io/external-dns/plan"`
`27`	`27`	`)`
`28`	`28`
	`29`	`+// SoftError is an error, that provider will only log as error instead`
	`30`	`+// of fatal. It is meant for error propagation from providers to tell`
	`31`	`+// that this is a transient error.`
`29`	`32`	`var SoftError error = errors.New("soft error")`
`30`	`33`
	`34`	`+// NewSoftError creates a SoftError from the given error`
`31`	`35`	`func NewSoftError(err error) error {`
`32`	`36`	`return errors.Join(SoftError, err)`
`33`	`37`	`}`