Skip to content

Commit

Permalink
docs: fix link and unlink references in codedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
tqwewe committed Jan 13, 2025
1 parent 888bcc0 commit fe40c46
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/actor/actor_ref.rs
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,8 @@ where
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// # });
/// ```
///
/// [`link`]: ActorRef::link
#[inline]
pub fn blocking_link<B: Actor>(&self, sibbling_ref: &ActorRef<B>) {
if self.id == sibbling_ref.id() {
Expand Down Expand Up @@ -457,7 +459,8 @@ where
/// Blockingly unlinks two previously linked sibling actors.
///
/// This method is intended for use cases where you need to link actors in synchronous code.
/// For async contexts, [`link`] is preferred.
/// For async contexts, [`unlink`] is preferred.
///
///
/// # Example
///
Expand All @@ -481,6 +484,8 @@ where
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// # });
/// ```
///
/// [`unlink`]: ActorRef::unlink
#[inline]
pub fn blocking_unlink<B>(&self, sibbling_ref: &ActorRef<B>)
where
Expand Down

0 comments on commit fe40c46

Please sign in to comment.