chore: rename WithLinkToDoc to WithRemediation

ratify-project · Aug 6, 2024 · 51c5402 · 51c5402
1 parent 220dfce
commit 51c5402
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/errors/types.go b/errors/types.go
@@ -151,8 +151,8 @@ func (ec ErrorCode) WithComponentType(componentType ComponentType) Error {
 	return newError(ec, ec.Message()).WithComponentType(componentType)
 }
 
-// WithLinkToDoc returns a new Error object with attached link to the documentation.
-func (ec ErrorCode) WithLinkToDoc(link string) Error {
+// WithRemediation returns a new Error object with remediation.
+func (ec ErrorCode) WithRemediation(link string) Error {
 	return newError(ec, ec.Message()).WithRemediation(link)
 }
 

diff --git a/errors/types_test.go b/errors/types_test.go
@@ -118,10 +118,10 @@ func TestWithComponentType(t *testing.T) {
 	}
 }
 
-func TestWithLinkToDoc(t *testing.T) {
-	err := testEC.WithLinkToDoc(testLink1)
+func TestWithRemediation(t *testing.T) {
+	err := testEC.WithRemediation(testLink1)
 	if err.remediation != testLink1 {
-		t.Fatalf("expected link to doc: %s, got: %s", testLink1, err.remediation)
+		t.Fatalf("expected remediation: %s, got: %s", testLink1, err.remediation)
 	}
 }