diff --git a/embassy-time/Cargo.toml b/embassy-time/Cargo.toml index 534894b20..7259169cd 100644 --- a/embassy-time/Cargo.toml +++ b/embassy-time/Cargo.toml @@ -41,11 +41,11 @@ mock-driver = ["tick-hz-1_000_000"] #! ### Generic Queue -## Create a global, generic queue that can be used with any executor +## Create a global, generic queue that can be used with any executor. ## To use this you must have a time driver provided. generic-queue = [] -#! The following features set how many timers are used for the generic queue. At most 1 +#! The following features set how many timers are used for the generic queue. At most one #! `generic-queue-*` feature can be enabled. If none is enabled, a default of 64 timers is used. #! #! When using embassy-time from libraries, you should *not* enable any `generic-queue-*` feature, to allow the diff --git a/embassy-time/README.md b/embassy-time/README.md index a4a622700..a4e150c14 100644 --- a/embassy-time/README.md +++ b/embassy-time/README.md @@ -3,8 +3,8 @@ Timekeeping, delays and timeouts. Timekeeping is done with elapsed time since system boot. Time is represented in -ticks, where the tick rate is defined either by the driver (in the case of a fixed- -rate tick) or chosen by the user with a [tick rate](#tick-rate) feature. The chosen +ticks, where the tick rate is defined either by the driver (in the case of a fixed-rate +tick) or chosen by the user with a [tick rate](#tick-rate) feature. The chosen tick rate applies to everything in `embassy-time` and thus determines the maximum timing resolution of (1 / tick_rate) seconds.