github/client-go
1
0
Fork 0
mirror of https://github.com/kubernetes/client-go.git synced 2025-06-27 15:39:39 +00:00
Code Issues Projects Releases Wiki Activity

docs: add comments for action.

Browse Source 
Kubernetes-commit: 993fe6f4bda183e1583cf0f879fbf9a076e99e8a
This commit is contained in:
Jianfei Bai 2019-09-20 21:32:44 +08:00 committed by Kubernetes Publisher
parent 297c8350f5
commit a537b01432
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
tools/events/interfaces.go
View File

@ -33,6 +33,9 @@ type EventRecorder interface {
// should be in UpperCamelCase format (starting with a capital letter). "reason" will be used
// to automate handling of events, so imagine people writing switch statements to handle them.
// You want to make that easy.
// 'action' explains what happened with regarding/what action did the ReportingController
// (ReportingController is a type of a Controller reporting an Event, e.g. k8s.io/node-controller, k8s.io/kubelet.)
// take in regarding's name; it should be in UpperCamelCase format (starting with a capital letter).
// 'note' is intended to be human readable.
Eventf(regarding runtime.Object, related runtime.Object, eventtype, reason, action, note string, args ...interface{})
}