summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlf Lilleengen <lulf@redhat.com>2022-06-15 09:05:48 +0200
committerUlf Lilleengen <lulf@redhat.com>2022-06-15 09:05:48 +0200
commit746bc75a8ec2576548b9ce5a956b0960d9c00737 (patch)
treec0646e1d1e2c53f0917d56a1081f5715fd32594f
parent624e46ccfb325c5e5ef15b34c7182cafdb62a7a2 (diff)
downloadembassy-746bc75a8ec2576548b9ce5a956b0960d9c00737.zip
FIx broken link warnings
-rw-r--r--embassy/src/channel/mpmc.rs2
-rw-r--r--embassy/src/executor/raw/mod.rs8
2 files changed, 5 insertions, 5 deletions
diff --git a/embassy/src/channel/mpmc.rs b/embassy/src/channel/mpmc.rs
index 48056cd8..1d03eef1 100644
--- a/embassy/src/channel/mpmc.rs
+++ b/embassy/src/channel/mpmc.rs
@@ -433,7 +433,7 @@ where
/// Attempt to immediately send a message.
///
- /// This method differs from [`send`] by returning immediately if the channel's
+ /// This method differs from [`send`](Channel::send) by returning immediately if the channel's
/// buffer is full, instead of waiting.
///
/// # Errors
diff --git a/embassy/src/executor/raw/mod.rs b/embassy/src/executor/raw/mod.rs
index 09429c19..b8455442 100644
--- a/embassy/src/executor/raw/mod.rs
+++ b/embassy/src/executor/raw/mod.rs
@@ -5,7 +5,7 @@
//! ## WARNING: here be dragons!
//!
//! Using this module requires respecting subtle safety contracts. If you can, prefer using the safe
-//! executor wrappers in [`crate::executor`] and the [`crate::task`] macro, which are fully safe.
+//! executor wrappers in [`executor`](crate::executor) and the [`embassy::task`](embassy_macros::task) macro, which are fully safe.
mod run_queue;
#[cfg(feature = "time")]
@@ -115,7 +115,7 @@ impl TaskHeader {
/// A `TaskStorage` must live forever, it may not be deallocated even after the task has finished
/// running. Hence the relevant methods require `&'static self`. It may be reused, however.
///
-/// Internally, the [embassy::task](crate::task) macro allocates an array of `TaskStorage`s
+/// Internally, the [embassy::task](embassy_macros::task) macro allocates an array of `TaskStorage`s
/// in a `static`. The most common reason to use the raw `Task` is to have control of where
/// the memory for the task is allocated: on the stack, or on the heap with e.g. `Box::leak`, etc.
@@ -158,7 +158,7 @@ impl<F: Future + 'static> TaskStorage<F> {
///
/// This function will fail if the task is already spawned and has not finished running.
/// In this case, the error is delayed: a "poisoned" SpawnToken is returned, which will
- /// cause [`Spawner::spawn()`] to return the error.
+ /// cause [`Spawner::spawn()`](super::Spawner::spawn) to return the error.
///
/// Once the task has finished running, you may spawn it again. It is allowed to spawn it
/// on a different executor.
@@ -230,7 +230,7 @@ impl<F: Future + 'static, const N: usize> TaskPool<F, N> {
///
/// This will loop over the pool and spawn the task in the first storage that
/// is currently free. If none is free, a "poisoned" SpawnToken is returned,
- /// which will cause [`Spawner::spawn()`] to return the error.
+ /// which will cause [`Spawner::spawn()`](super::Spawner::spawn) to return the error.
pub fn spawn(&'static self, future: impl FnOnce() -> F) -> SpawnToken<impl Sized> {
for task in &self.pool {
if task.spawn_mark_used() {