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

pull/24376/head
wiedld 2023-07-27 15:36:35 -07:00
parent d7fee9fdb8
commit 9a7ff9ecfc
3 changed files with 4 additions and 3 deletions

View File

@ -6,7 +6,7 @@ use futures::stream::BoxStream;
pub mod endless; pub mod endless;
pub mod once; pub mod once;
/// Source for partitions. /// Source for compaction jobs.
pub trait CompactionJobStream: Debug + Display + Send + Sync { pub trait CompactionJobStream: Debug + Display + Send + Sync {
/// Create new source stream of compaction jobs. /// Create new source stream of compaction jobs.
/// ///

View File

@ -19,7 +19,7 @@ use compactor_scheduler::CompactionJob;
/// A source of partitions, noted by [`CompactionJob`](compactor_scheduler::CompactionJob), that may potentially need compacting. /// A source of partitions, noted by [`CompactionJob`](compactor_scheduler::CompactionJob), that may potentially need compacting.
#[async_trait] #[async_trait]
pub trait CompactionJobsSource: Debug + Display + Send + Sync { 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. /// This method performs retries.
/// ///

View File

@ -40,7 +40,8 @@ pub async fn compact(
.map(|job| { .map(|job| {
let components = Arc::clone(components); 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. // scheduler's span via something passed through compaction_job_stream.
let root_span: Option<Span> = trace_collector let root_span: Option<Span> = trace_collector
.as_ref() .as_ref()