From c5a80fc61e65fa496067e9e618f8d153e2439e0d Mon Sep 17 00:00:00 2001 From: Lucas Colombo Date: Mon, 8 Apr 2024 17:49:06 -0300 Subject: [PATCH] =?UTF-8?q?docs(sched):=20=F0=9F=93=9D=20improve=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- lib/sched/README.md | 20 ++++++++++++++------ 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f345c45..467d2d4 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ several features and "sub-features". - [x] [macros](lib/macros) - [x] [sched](lib/sched)  has subfeatures -> [!NOTE] Sub-Features +> [!NOTE] > > has subfeatures ยป Means that the feature has sub-features. > diff --git a/lib/sched/README.md b/lib/sched/README.md index 1a77516..5db8999 100644 --- a/lib/sched/README.md +++ b/lib/sched/README.md @@ -21,14 +21,22 @@ This library is for internal use. And as such, it's only published privately. cargo add lool --registry=lugit --features sched ``` -# Additional Features +# Sub-Features -- `sched.tokio`: Enables the `tokio` runtime support. -- `sched.rule-recurrent`: Enables the "recurrent-rule" style for scheduling tasks. -- `sched.rule-cron`: Enables the "cron-like" style for scheduling tasks -> [!WARNING] Not implemented warning -> although the `sched.rule-cron` feature is available, it's not yet implemented. +### has subfeatures  sched.tokio + +Enables the `tokio` runtime support, replacing the default behaviour, which implies a `std::thread` pool to run the tasks. + +### has subfeatures  sched.rule-recurrent + +Enables the "**recurrent-rule**" style for scheduling tasks. + +### has subfeatures  sched.rule-cron + +> [!WARNING] +> +> Not yet implemented ## Planned Features