docs

risingwavelabs · Nov 3, 2023 · 54bd7b6 · 54bd7b6
1 parent 4d487f0
commit 54bd7b6
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/meta/src/barrier/progress.rs b/src/meta/src/barrier/progress.rs
@@ -159,8 +159,11 @@ impl TrackingJob {
         }
     }
 
+    /// Returns whether the `TrackingJob` requires a checkpoint to complete.
     pub(crate) fn is_checkpoint(&self) -> bool {
         match self {
+            // Recovered tracking job is always a streaming job,
+            // It requires a checkpoint to complete.
             TrackingJob::Recovered(_) => true,
             TrackingJob::New(command) => {
                 command.context.kind.is_initial() || command.context.kind.is_checkpoint()