docs(sched): 📝 improve docs

This commit is contained in:
Lucas Colombo 2024-04-08 17:49:06 -03:00
parent f5e222a81f
commit c5a80fc61e
Signed by: lucas
GPG Key ID: EF34786CFEFFAE35
2 changed files with 15 additions and 7 deletions

View File

@ -23,7 +23,7 @@ several features and "sub-features".
- [x] [macros](lib/macros)
- [x] [sched](lib/sched)&nbsp;&nbsp;<picture><img alt="has subfeatures" src=".github/img/icon-has-submodules.svg" height="12"></picture>
> [!NOTE] Sub-Features
> [!NOTE]
>
> <picture><img alt="has subfeatures" src=".github/img/icon-has-submodules.svg" height="12"></picture> » Means that the feature has sub-features.
>

View File

@ -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.
### <picture><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></picture>&nbsp;&nbsp;sched.tokio
Enables the `tokio` runtime support, replacing the default behaviour, which implies a `std::thread` pool to run the tasks.
### <picture><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></picture>&nbsp;&nbsp;sched.rule-recurrent
Enables the "**recurrent-rule**" style for scheduling tasks.
### <picture><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></picture>&nbsp;&nbsp;sched.rule-cron
> [!WARNING]
>
> Not yet implemented
## Planned Features