add godoc for events to events.k8s.io

This commit is contained in:
David Eads 2020-10-27 14:06:15 -04:00
parent f95ec84322
commit 4af2f7d37f
2 changed files with 10 additions and 0 deletions

View File

@ -25,6 +25,11 @@ import (
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.
// Events have a limited retention time and triggers and messages may evolve
// with time. Event consumers should not rely on the timing of an event
// with a given Reason reflecting a consistent underlying trigger, or the
// continued existence of events with that Reason. Events should be
// treated as informative, best-effort, supplemental data.
type Event struct {
metav1.TypeMeta `json:",inline"`

View File

@ -27,6 +27,11 @@ import (
// +k8s:prerelease-lifecycle-gen:deprecated=1.22
// Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.
// Events have a limited retention time and triggers and messages may evolve
// with time. Event consumers should not rely on the timing of an event
// with a given Reason reflecting a consistent underlying trigger, or the
// continued existence of events with that Reason. Events should be
// treated as informative, best-effort, supplemental data.
type Event struct {
metav1.TypeMeta `json:",inline"`