correct docs and comments

Signed-off-by: sivchari <shibuuuu5@gmail.com>

Author: sivchari

pkg/analysis/duplicatemarkers/doc.go

@@ -16,21 +16,24 @@ limitations under the License.
 
 /*
 duplicatemarkers is an analyzer that checks for duplicate markers in the API types.
+It reports exact matches for marker definitions.
 
-It reports only if the marker and value together are completely unique now. For example, the `duplicatemarkers` will not diagnose the field has kubebuilder:validation:MaxLength=10 and kubebuilder:validation:MaxLength=11
-
-Example:
+For example, something like:
 
 	type Foo struct {
 		// +kubebuilder:validation:MaxLength=10
 		// +kubebuilder:validation:MaxLength=11
-		Field string `json:"field"`
+		type Bar string
 	}
 
-	// +kubebuilder:validation:MaxLength=10
-	// +kubebuilder:validation:MaxLength=11
-	type Bar string
+would not be reported while something like:
+
+	type Foo struct {
+		// +kubebuilder:validation:MaxLength=10
+		// +kubebuilder:validation:MaxLength=10
+		type Bar string
+	}
 
-About the duplicated markers which has different value, it requires specific rule for each marker, these are processed by its corresponding linter.
+would be reported.
 */
 package duplicatemarkers

pkg/analysis/duplicatemarkers/testdata/src/a/a.go

@@ -22,8 +22,8 @@ type DuplicatedMaxLength int // want "DuplicatedMaxLength has duplicated markers
 // +kubebuilder:object:root=true
 type DuplicateMarkerSpec struct { // want "DuplicateMarkerSpec has duplicated markers kubebuilder:object:root"
 	// +kubebuilder:validation:Required
-	// shpuld be ignored since it only has single marker
-	UniqueRequired string `json:"uniqueRequired"`
+	// should be ignored since it only has single marker
+	Required string `json:"required"`
 
 	// +listType=map
 	// +listMapKey=primaryKey

pkg/analysis/duplicatemarkers/testdata/src/a/a.go.golden

@@ -19,8 +19,8 @@ type DuplicatedMaxLength int // want "DuplicatedMaxLength has duplicated markers
 // +kubebuilder:subresource:status
 type DuplicateMarkerSpec struct { // want "DuplicateMarkerSpec has duplicated markers kubebuilder:object:root"
 	// +kubebuilder:validation:Required
-	// shpuld be ignored since it only has single marker
-	UniqueRequired string `json:"uniqueRequired"`
+	// should be ignored since it only has single marker
+	Required string `json:"required"`
 
 	// +listType=map
 	// +listMapKey=primaryKey