mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-12 09:24:23 +00:00
Indent preformatted text in kstatus doc.go
This indents the code examples in the kstatus doc.go files so that they'll be placed inside <pre> blocks by godoc. Without this change only the coincidentally indented lines are marked as preformatted in godoc HTML output.
This commit is contained in:
@@ -4,7 +4,7 @@
|
|||||||
// Package kstatus contains functionality for computing the status
|
// Package kstatus contains functionality for computing the status
|
||||||
// of Kubernetes resources.
|
// of Kubernetes resources.
|
||||||
//
|
//
|
||||||
// The statuses defined in this package is:
|
// The statuses defined in this package are:
|
||||||
// * InProgress
|
// * InProgress
|
||||||
// * Current
|
// * Current
|
||||||
// * Failed
|
// * Failed
|
||||||
@@ -13,11 +13,12 @@
|
|||||||
//
|
//
|
||||||
// Computing the status of a resources can be done by calling the
|
// Computing the status of a resources can be done by calling the
|
||||||
// Compute function in the status package.
|
// Compute function in the status package.
|
||||||
|
//
|
||||||
// import (
|
// import (
|
||||||
// "sigs.k8s.io/kustomize/kstatus/status"
|
// "sigs.k8s.io/kustomize/kstatus/status"
|
||||||
// )
|
// )
|
||||||
// res, err := status.Compute(resource)
|
|
||||||
//
|
//
|
||||||
|
// res, err := status.Compute(resource)
|
||||||
//
|
//
|
||||||
// The package also defines a set of new conditions:
|
// The package also defines a set of new conditions:
|
||||||
// * InProgress
|
// * InProgress
|
||||||
@@ -31,8 +32,10 @@
|
|||||||
// the standard conditions described above. The values of
|
// the standard conditions described above. The values of
|
||||||
// these conditions are decided based on other status information
|
// these conditions are decided based on other status information
|
||||||
// available in the resources.
|
// available in the resources.
|
||||||
|
//
|
||||||
// import (
|
// import (
|
||||||
// "sigs.k8s.io/kustomize/kstatus/status
|
// "sigs.k8s.io/kustomize/kstatus/status
|
||||||
// )
|
// )
|
||||||
|
//
|
||||||
// err := status.Augment(resource)
|
// err := status.Augment(resource)
|
||||||
package status
|
package status
|
||||||
|
|||||||
@@ -43,6 +43,7 @@
|
|||||||
// import (
|
// import (
|
||||||
// "sigs.k8s.io/kustomize/kstatus/wait"
|
// "sigs.k8s.io/kustomize/kstatus/wait"
|
||||||
// )
|
// )
|
||||||
|
//
|
||||||
// resolver := wait.NewResolver(client)
|
// resolver := wait.NewResolver(client)
|
||||||
// eventsChan := resolver.WaitForStatus(context.Background(), resourceIdentifiers, 2 * time.Second)
|
// eventsChan := resolver.WaitForStatus(context.Background(), resourceIdentifiers, 2 * time.Second)
|
||||||
// for {
|
// for {
|
||||||
|
|||||||
Reference in New Issue
Block a user