diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2022-08-22 14:43:56 +0000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-08-22 14:43:56 +0000 |
| commit | 61356181b223e95f289ca3af3a038a699cde2112 (patch) | |
| tree | 2633607c1d62ed6f7482ee596325c9da24cb566e /embassy-executor/src | |
| parent | 53fbd0efb3e77e1e3de948afde2b5bf1a5a9735f (diff) | |
| parent | 3e155d2ec366379584bf7ba4a447109555aa0d77 (diff) | |
Merge #918
918: Doc warnings r=Dirbaio a=lulf
Fixing a few doc warnings in embassy-executor, embassy-time, embassy-usb and embassy-nrf. There are more left, but I need a break :D
Co-authored-by: Ulf Lilleengen <[email protected]>
Diffstat (limited to 'embassy-executor/src')
| -rw-r--r-- | embassy-executor/src/raw/mod.rs | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/embassy-executor/src/raw/mod.rs b/embassy-executor/src/raw/mod.rs index c55d10699..e1258ebb5 100644 --- a/embassy-executor/src/raw/mod.rs +++ b/embassy-executor/src/raw/mod.rs | |||
| @@ -5,7 +5,7 @@ | |||
| 5 | //! ## WARNING: here be dragons! | 5 | //! ## WARNING: here be dragons! |
| 6 | //! | 6 | //! |
| 7 | //! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe | 7 | //! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe |
| 8 | //! executor wrappers in [`executor`](crate::executor) and the [`embassy_executor::task`](embassy_macros::task) macro, which are fully safe. | 8 | //! [executor wrappers](crate::Executor) and the [`embassy_executor::task`](embassy_macros::task) macro, which are fully safe. |
| 9 | 9 | ||
| 10 | mod run_queue; | 10 | mod run_queue; |
| 11 | #[cfg(feature = "integrated-timers")] | 11 | #[cfg(feature = "integrated-timers")] |
| @@ -249,7 +249,7 @@ impl<F: Future + 'static, const N: usize> TaskPool<F, N> { | |||
| 249 | /// | 249 | /// |
| 250 | /// This is the core of the Embassy executor. It is low-level, requiring manual | 250 | /// This is the core of the Embassy executor. It is low-level, requiring manual |
| 251 | /// handling of wakeups and task polling. If you can, prefer using one of the | 251 | /// handling of wakeups and task polling. If you can, prefer using one of the |
| 252 | /// higher level executors in [`crate::executor`]. | 252 | /// [higher level executors](crate::Executor). |
| 253 | /// | 253 | /// |
| 254 | /// The raw executor leaves it up to you to handle wakeups and scheduling: | 254 | /// The raw executor leaves it up to you to handle wakeups and scheduling: |
| 255 | /// | 255 | /// |
