From bff78dab525b1c2ab659dec9aa988eb85cfb02ff Mon Sep 17 00:00:00 2001 From: "ZhengYu, Xu" Date: Wed, 2 Nov 2022 14:00:16 +0800 Subject: [PATCH] chore: variant-level now can use doc comment (#33) Since kube fix it in https://github.com/kube-rs/kube/pull/1051, we can use doc comment on variants --- crates/habitat-api/src/batch.rs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/crates/habitat-api/src/batch.rs b/crates/habitat-api/src/batch.rs index 690d506..f36b66e 100644 --- a/crates/habitat-api/src/batch.rs +++ b/crates/habitat-api/src/batch.rs @@ -62,20 +62,20 @@ pub struct JobStatus { #[derive(Deserialize, Serialize, Clone, Debug, JsonSchema)] pub enum JobStatusPhase { - // Pending means the job has been accepted by the system, but one or more of pods has not been - // scheduled. + /// Pending means the job has been accepted by the system, but one or more of pods has not been + /// scheduled. Pending, - // Ready means the scheduler approves the controller to create pods. + /// Ready means the scheduler approves the controller to create pods. Ready, - // Running means that if the job contains any `Running` pod, its status will be `Running`. + /// Running means that if the job contains any `Running` pod, its status will be `Running`. Running, - // Terminating means that the job is terminated, and waiting for releasing pods. + /// Terminating means that the job is terminated, and waiting for releasing pods. Terminating, - // Succeeded means that the job is completed with success. + /// Succeeded means that the job is completed with success. Succeeded, - // Succeeded means that the job is completed with failure. + /// Succeeded means that the job is completed with failure. Failed, - // Terminated means that the job is completed with unexpected. + /// Terminated means that the job is completed with unexpected. Terminated, }