Skip to content

Commit

Permalink
polish comments of non-enum values.
Browse files Browse the repository at this point in the history
types: PodConditionType, NodeConditionType

Kubernetes-commit: f4cd617b74f7d36d0e181ad8a241016470aeb183
  • Loading branch information
jiahuif authored and k8s-publishing-bot committed Mar 14, 2022
1 parent 5358347 commit e1e0014
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion batch/v1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ type UncountedTerminatedPods struct {

type JobConditionType string

// These are valid conditions of a job.
// These are built-in conditions of a job.
const (
// JobSuspended means the job has been suspended.
JobSuspended JobConditionType = "Suspended"
Expand Down
13 changes: 7 additions & 6 deletions core/v1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -2636,7 +2636,7 @@ const (
// PodConditionType is a valid value for PodCondition.Type
type PodConditionType string

// These are valid conditions of pod.
// These are built-in conditions of pod. An application may use a custom condition not listed here.
const (
// ContainersReady indicates whether all containers in the pod are ready.
ContainersReady PodConditionType = "ContainersReady"
Expand Down Expand Up @@ -5055,8 +5055,8 @@ const (

type NodeConditionType string

// These are valid conditions of node. Currently, we don't have enough information to decide
// node condition. In the future, we will add more. The proposed set of conditions are:
// These are valid but not exhaustive conditions of node. A cloud provider may set a condition not listed here.
// The built-in set of conditions are:
// NodeReachable, NodeLive, NodeReady, NodeSchedulable, NodeRunnable.
const (
// NodeReady means kubelet is healthy and ready to accept pods.
Expand Down Expand Up @@ -5093,7 +5093,7 @@ type NodeCondition struct {

type NodeAddressType string

// These are valid address type of node.
// These are built-in addresses type of node. A cloud provider may set a type not listed here.
const (
// NodeHostName identifies a name of the node. Although every node can be assumed
// to have a NodeAddress of this type, its exact syntax and semantics are not
Expand Down Expand Up @@ -5265,7 +5265,7 @@ const (

type NamespaceConditionType string

// These are valid conditions of a namespace.
// These are built-in conditions of a namespace.
const (
// NamespaceDeletionDiscoveryFailure contains information about namespace deleter errors during resource discovery.
NamespaceDeletionDiscoveryFailure NamespaceConditionType = "NamespaceDeletionDiscoveryFailure"
Expand Down Expand Up @@ -5753,7 +5753,8 @@ type EventList struct {
// List holds a list of objects, which may not be known by the server.
type List metav1.List

// LimitType is a type of object that is limited
// LimitType is a type of object that is limited. It can be Pod, Container, PersistentVolumeClaim or
// a fully qualified resource name.
type LimitType string

const (
Expand Down

0 comments on commit e1e0014

Please sign in to comment.