Merge pull request #4438 from fengshunli/desc

k8s-ci-robot · web-flow · commit 3e7c1d29ce66 · 2024-12-25T09:06:10.000+01:00
🌱 add better description to MarshalYAML and UnmarshalYAML methods
diff --git a/pkg/config/interface.go b/pkg/config/interface.go
@@ -95,8 +95,8 @@ type Config interface {
 
 	/* Persistence */
 
-	// Marshal returns the YAML representation of the Config.
+	// MarshalYAML Marshal returns the YAML representation of the Config.
 	MarshalYAML() ([]byte, error)
-	// Unmarshal loads the Config fields from its YAML representation.
+	// UnmarshalYAML Unmarshal loads the Config fields from its YAML representation.
 	UnmarshalYAML([]byte) error
 }

Original file line number	Diff line number	Diff line change
`@@ -95,8 +95,8 @@ type Config interface {`
`95`	`95`
`96`	`96`	`/* Persistence */`
`97`	`97`
`98`		`- // Marshal returns the YAML representation of the Config.`
	`98`	`+ // MarshalYAML Marshal returns the YAML representation of the Config.`
`99`	`99`	`MarshalYAML() ([]byte, error)`
`100`		`- // Unmarshal loads the Config fields from its YAML representation.`
	`100`	`+ // UnmarshalYAML Unmarshal loads the Config fields from its YAML representation.`
`101`	`101`	`UnmarshalYAML([]byte) error`
`102`	`102`	`}`