Skip to content

Commit a610c22

Browse files
authored
Fix typos in TaskMetric docs (#103)
1 parent c020b81 commit a610c22

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

src/task.rs

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -899,10 +899,6 @@ pub struct TaskMetrics {
899899
/// An idle is recorded as occurring if a non-zero duration elapses between the instant a
900900
/// task completes a poll, and the instant that it is next awoken.
901901
///
902-
/// ##### Derived metrics
903-
/// - **[`max_idle_duration`][TaskMetrics::max_idle_duration]**
904-
/// The longest duration a task spent idle.
905-
///
906902
/// ##### Examples
907903
/// ```
908904
/// #[tokio::main(flavor = "current_thread", start_paused = true)]
@@ -944,8 +940,8 @@ pub struct TaskMetrics {
944940
/// execution).
945941
///
946942
/// ##### Definition
947-
/// This metric is equal to [`total_short_delay_duration`][TaskMetrics::total_short_delay_duration]
948-
/// \+ [`total_long_delay_duration`][TaskMetrics::total_long_delay_duration].
943+
/// This metric is equal to [`total_short_delay_count`][TaskMetrics::total_short_delay_count]
944+
/// \+ [`total_long_delay_count`][TaskMetrics::total_long_delay_count].
949945
///
950946
/// ##### Derived metrics
951947
/// - **[`mean_scheduled_duration`][TaskMetrics::mean_scheduled_duration]**
@@ -1016,8 +1012,8 @@ pub struct TaskMetrics {
10161012
/// The total duration that tasks spent waiting to be polled after awakening.
10171013
///
10181014
/// ##### Definition
1019-
/// This metric is equal to [`total_short_delay_count`][TaskMetrics::total_short_delay_count]
1020-
/// \+ [`total_long_delay_count`][TaskMetrics::total_long_delay_count].
1015+
/// This metric is equal to [`total_short_delay_duration`][TaskMetrics::total_short_delay_duration]
1016+
/// \+ [`total_long_delay_duration`][TaskMetrics::total_long_delay_duration].
10211017
///
10221018
/// ##### Derived metrics
10231019
/// - **[`mean_scheduled_duration`][TaskMetrics::mean_scheduled_duration]**
@@ -1434,10 +1430,11 @@ pub struct TaskMetrics {
14341430
/// The mean duration of short scheduling delays.
14351431
pub total_short_delay_duration: Duration,
14361432

1437-
/// The total number of times that a task had a long scheduling duration.
1433+
/// The total duration of tasks with long scheduling delays.
14381434
///
1439-
/// Here, a long scheduling duration is defined as taking longer to start execution after
1440-
/// scheduling than [`long_delay_threshold`][TaskMonitor::long_delay_threshold].
1435+
/// This is defined as tasks taking
1436+
/// [`long_delay_threshold`][TaskMonitor::long_delay_threshold] or longer to be executed
1437+
/// after being scheduled.
14411438
///
14421439
/// ##### Derived metrics
14431440
/// - **[`mean_long_delay_duration`][TaskMetrics::mean_long_delay_duration]**

0 commit comments

Comments
 (0)