Skip to content

Commit

Permalink
Small fixes to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomasdezeeuw committed Mar 16, 2024
1 parent 7cebec3 commit 9aa893c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions rt/src/shared/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ use crate::{trace, ThreadSafe};
/// # Notes
///
/// This type only exists because [`Arc::new_cyclic`] doesn't work when
/// returning a result. And as [`RuntimeInternals`] needs to create a [`Poll`]
/// instance, which can fail, creating a new `RuntimeInternals` inside
/// returning a result. And as [`RuntimeInternals`] needs to create an
/// [`a10::Ring`], which can fail, creating a new `RuntimeInternals` inside
/// `Arc::new_cyclic` doesn't work. So it needs to be a two step process, where
/// the second step (`RuntimeSetup::complete`) doesn't return an error and can
/// be called inside `Arc::new_cyclic`.
Expand Down
4 changes: 2 additions & 2 deletions rt/src/sync_worker.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
//! stopping the thread).
//!
//! The [`sync_worker::Handle`] type is a handle to the sync worker thread
//! managed by the [coordinator]. The [`main`] function is the entry point for
//! the sync worker thread.
//! managed by the [coordinator]. The [`start`] function can be used to start a
//! new synchronous actor.
//!
//! [coordinator]: crate::coordinator
//! [`sync_worker::Handle`]: Handle
Expand Down
2 changes: 1 addition & 1 deletion rt/src/wakers/shared.rs
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ struct WakersId(u8);
/// more writes are allowed and the array element is read only.
///
/// Following the rules above means that there are no data races. The array can
/// only be indexed by [`WakersId`], which is only created by [`Waker::new`],
/// only be indexed by [`WakersId`], which is only created by [`Wakers::new`],
/// which ensures the waker is setup before returning the [`WakersId`]. This
/// ensures that only a single write happens to each element of the array. And
/// because after the initial write each element is read only there are no
Expand Down

0 comments on commit 9aa893c

Please sign in to comment.