docs: add default percentage

Signed-off-by: hi-rustin <rustin.liu@gmail.com>
tokio-rs · Jan 9, 2024 · 750c4f6 · 750c4f6
1 parent ed610e6
commit 750c4f6
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -218,7 +218,8 @@ Options:
           Each warning is specified by its name, which is one of:
 
           * `self-wakes` -- Warns when a task wakes itself more than a
-          certain percentage of its total wakeups.
+          certain percentage of its total wakeups. Default percentage is
+          50%.
 
           * `lost-waker` -- Warns when a task is dropped without being
           woken.

diff --git a/tokio-console/src/config.rs b/tokio-console/src/config.rs
@@ -57,6 +57,7 @@ pub struct Config {
     /// Each warning is specified by its name, which is one of:
     ///
     /// * `self-wakes` -- Warns when a task wakes itself more than a certain percentage of its total wakeups.
+    ///                   Default percentage is 50%.
     ///
     /// * `lost-waker` -- Warns when a task is dropped without being woken.
     ///

diff --git a/tokio-console/tests/cli-ui.stdout b/tokio-console/tests/cli-ui.stdout
@@ -47,7 +47,8 @@ Options:
           Each warning is specified by its name, which is one of:
 
           * `self-wakes` -- Warns when a task wakes itself more than a
-          certain percentage of its total wakeups.
+          certain percentage of its total wakeups. Default percentage is
+          50%.
 
           * `lost-waker` -- Warns when a task is dropped without being
           woken.