chore(idpe-17789): update code comments to reflect both jobs and part…

…itions
Shopify · Jul 27, 2023 · 9a7ff9e · 9a7ff9e
1 parent d7fee9f
commit 9a7ff9e
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/compactor/src/components/compaction_job_stream/mod.rs b/compactor/src/components/compaction_job_stream/mod.rs
@@ -6,7 +6,7 @@ use futures::stream::BoxStream;
 pub mod endless;
 pub mod once;
 
-/// Source for partitions.
+/// Source for compaction jobs.
 pub trait CompactionJobStream: Debug + Display + Send + Sync {
  /// Create new source stream of compaction jobs.
  ///

diff --git a/compactor/src/components/compaction_jobs_source/mod.rs b/compactor/src/components/compaction_jobs_source/mod.rs
@@ -19,7 +19,7 @@ use compactor_scheduler::CompactionJob;
 /// A source of partitions, noted by [`CompactionJob`](compactor_scheduler::CompactionJob), that may potentially need compacting.
 #[async_trait]
 pub trait CompactionJobsSource: Debug + Display + Send + Sync {
- /// Get partition IDs.
+ /// Get compaction jobs. (For now, 1 job equals 1 partition ID).
  ///
  /// This method performs retries.
  ///

diff --git a/compactor/src/driver.rs b/compactor/src/driver.rs
@@ -40,7 +40,8 @@ pub async fn compact(
  .map(|job| {
  let components = Arc::clone(components);
 
- // A root span is created for each partition. Later this can be linked to the
+ // A root span is created for each compaction job (a.k.a. partition).
+ // Later this can be linked to the
  // scheduler's span via something passed through compaction_job_stream.
  let root_span: Option<Span> = trace_collector
  .as_ref()