Merge pull request kubevirt#13853 from dhiller/fix-decorator-doc

godoc: fixes for decorators.go

Author: kubevirt-bot

tests/decorators/decorators.go

@@ -7,7 +7,8 @@ var (
 	Periodic    = Label("PERIODIC")
 	Conformance = Label("conformance")
 
-	// SIGs
+	/* SIGs */
+
 	SigCompute           = Label("sig-compute")
 	SigOperator          = Label("sig-operator")
 	SigNetwork           = Label("sig-network")
@@ -17,7 +18,8 @@ var (
 	SigMonitoring        = Label("sig-monitoring")
 	SigPerformance       = Label("sig-performance")
 
-	// HW
+	/* HW */
+
 	GPU         = Label("GPU")
 	VGPU        = Label("VGPU")
 	SEV         = Label("SEV")
@@ -30,11 +32,13 @@ var (
 	KSMRequired = Label("KSM-required")
 	ACPI        = Label("ACPI")
 
-	// Deployment
+	/* Deployment */
+
 	SingleReplica = Label("single-replica")
 	MultiReplica  = Label("multi-replica")
 
-	// Features
+	/* Features */
+
 	CPUModel                             = Label("cpumodel")
 	VSOCK                                = Label("vsock")
 	VirtioFS                             = Label("virtiofs")
@@ -63,33 +67,40 @@ var (
 	RequiresHugepages2Mi                 = Label("requireHugepages2Mi")
 	RequiresHugepages1Gi                 = Label("requireHugepages1Gi")
 
-	// Storage classes
-	// Requires a storage class with support for snapshots
+	/* Storage classes */
+
+	// RequiresSnapshotStorageClass requires a storage class with support for snapshots
 	RequiresSnapshotStorageClass = Label("RequiresSnapshotStorageClass")
-	// Requires a storage class without support for snapshots
+	// RequiresNoSnapshotStorageClass requires a storage class without support for snapshots
 	RequiresNoSnapshotStorageClass = Label("RequiresNoSnapshotStorageClass")
-	// Requires a storage class with ReadWriteMany Block support
+	// RequiresRWXBlock requires a storage class with ReadWriteMany Block support
 	RequiresRWXBlock = Label("RequiresRWXBlock")
-	// Requires the VMStateStorageClass to be set to ReadWriteOnce Filesystem storage class
+	// RequiresRWOFsVMStateStorageClass requires the VMStateStorageClass to be set to ReadWriteOnce Filesystem storage class
 	RequiresRWOFsVMStateStorageClass = Label("RequiresRWOFsVMStateStorageClass")
-	// Requires the VMStateStorageClass to be set to ReadWriteMany Filesystem storage class
+	// RequiresRWXFsVMStateStorageClass requires the VMStateStorageClass to be set to ReadWriteMany Filesystem storage class
 	RequiresRWXFsVMStateStorageClass = Label("RequiresRWXFsVMStateStorageClass")
 
-	// Requires a storage class with Block storage support
+	// RequiresBlockStorage requires a storage class with Block storage support
 	RequiresBlockStorage = Label("RequiresBlockStorage")
-	// Tests that ensure sig-storage functionality which are conformance-unready
+	// StorageCritical tests that ensure sig-storage functionality which are conformance-unready
 	StorageCritical = Label("StorageCritical")
-	// Requires a storage class with volume expansion support
+	// RequiresVolumeExpansion requires a storage class with volume expansion support
 	RequiresVolumeExpansion = Label("RequiresVolumeExpansion")
+
+	/* Kubernetes versions */
+
 	// Kubernetes versions
 	Kubernetes130 = Label("kubernetes130")
-	// WG archs
+
+	/* architecture working groups */
+
 	WgS390x = Label("wg-s390x")
 	WgArm64 = Label("wg-arm64")
+
 	// Virtctl related tests
 	Virtctl = Label("virtctl")
 
-	// NoFlakeChecker decorates tests that are not compatible with the check-tests-for-flakes test lane.
+	// NoFlakeCheck decorates tests that are not compatible with the check-tests-for-flakes test lane.
 	// This should only be used for legitimate purposes, like on tests that have a flake-checker-friendly clone.
 	NoFlakeCheck = Label("no-flake-check")
 )