github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

kubectl: rewrite docstrings in several files

Browse Source 
Fixing inaccuracies and clarifying in the case of ambiguities.
This commit is contained in:
Alexander Campbell
2017-05-25 12:23:22 -07:00
parent d29560d89a
commit f9913c4948
8 changed files with 31 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pkg/kubectl/stop.go
View File

@@ -46,11 +46,12 @@ const (
Timeout = time.Minute * 5
)
// A Reaper handles terminating an object as gracefully as possible.
// timeout is how long we'll wait for the termination to be successful
// gracePeriod is time given to an API object for it to delete itself cleanly,
// e.g., pod shutdown. It may or may not be supported by the API object.
// A Reaper terminates an object as gracefully as possible.
type Reaper interface {
// Stop a given object within a namespace. timeout is how long we'll
// wait for the termination to be successful. gracePeriod is time given
// to an API object for it to delete itself cleanly (e.g., pod
// shutdown). It may or may not be supported by the API object.
Stop(namespace, name string, timeout time.Duration, gracePeriod *metav1.DeleteOptions) error
}