Merge pull request #305 from droot/book/help-for-desc-limit

📖 generate help for maxDecLen commandline parameter

Author: k8s-ci-robot

pkg/crd/gen.go

@@ -40,11 +40,11 @@ type Generator struct {
 	// the CRD's schema.
 	TrivialVersions bool `marker:",optional"`
 
-	// MaxDescLen limits the description length of each field in CRD's OpenAPI schema.
+	// MaxDescLen specifies the maximum description length for fields in CRD's OpenAPI schema.
 	//
-	// nil (default) indicates no limit on description of fields
-	// 0 indicates drop the description completely
-	// n means at most n characters
+	// 0 indicates drop the description for all fields completely.
+	// n indicates limit the description to at most n characters and truncate the description to
+	// closest sentence boundary if it exceeds n characters.
 	MaxDescLen *int `marker:",optional"`
 }
 

pkg/crd/zz_generated.markerhelp.go

@@ -36,6 +36,10 @@ func (Generator) Help() *markers.DefinitionHelp {
 				Summary: "indicates that we should produce a single-version CRD. ",
 				Details: " Single \"trivial-version\" CRDs are compatible with older (pre 1.13) Kubernetes API servers.  The storage version's schema will be used as the CRD's schema.",
 			},
+			"MaxDescLen": markers.DetailedHelp{
+				Summary: "specifies the maximum description length for fields in CRD's OpenAPI schema. ",
+				Details: " 0 indicates drop the description for all fields completely. n indicates limit the description to at most n characters and truncate the description to closest sentence boundary if it exceeds n characters.",
+			},
 		},
 	}
 }