docs(sched): 📝 improve docs
This commit is contained in:
parent
f5e222a81f
commit
c5a80fc61e
@ -23,7 +23,7 @@ several features and "sub-features".
|
|||||||
- [x] [macros](lib/macros)
|
- [x] [macros](lib/macros)
|
||||||
- [x] [sched](lib/sched) <picture><img alt="has subfeatures" src=".github/img/icon-has-submodules.svg" height="12"></picture>
|
- [x] [sched](lib/sched) <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.
|
> <picture><img alt="has subfeatures" src=".github/img/icon-has-submodules.svg" height="12"></picture> » Means that the feature has sub-features.
|
||||||
>
|
>
|
||||||
|
|||||||
@ -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
|
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
|
### <picture><img alt="has subfeatures" src="../../.github/img/icon-has-submodules.svg" height="12"></picture> sched.tokio
|
||||||
> although the `sched.rule-cron` feature is available, it's not yet implemented.
|
|
||||||
|
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> 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> sched.rule-cron
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
>
|
||||||
|
> Not yet implemented
|
||||||
|
|
||||||
## Planned Features
|
## Planned Features
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user