1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-10 01:46:55 +00:00
kyverno/cmd/cli/kubectl-kyverno/utils/cobra/docs.go
Charles-Edouard Brétéché c51bc5beb8
docs: improve cli commands docs (#8259)
* chore: improve cli commands docs

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* docs

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* fix

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* fix

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* fix test

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* experimental

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* version

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* unit tests

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* oci

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* oci

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* jp

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* apply

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

* create

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

---------

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
2023-09-05 05:14:28 +03:00

45 lines
979 B
Go

package cobra
import "strings"
func FormatDescription(short bool, url string, experimental bool, lines ...string) string {
if len(lines) == 0 {
return ""
}
description := lines[0]
if short {
return description
}
description += "\n"
for _, line := range lines[1:] {
description += " "
description += line
description += "\n"
}
if experimental {
description += "\n"
description += " "
description += "NOTE: This is an experimental command, use `KYVERNO_EXPERIMENTAL=true` to enable it."
description += "\n"
}
if url != "" {
description += "\n"
description += " "
description += "For more information visit " + url
description += "\n"
}
return strings.TrimSpace(description)
}
func FormatExamples(in ...[]string) string {
var examples string
for _, example := range in {
for _, line := range example {
examples += " "
examples += line
examples += "\n"
}
examples += "\n"
}
return strings.TrimRight(examples, " \n")
}