e35dc28 REVIEW: fix doc links — heartwood

Radicle Heartwood Protocol & Stack

REVIEW: fix doc links

Fintan Halpenny committed 7 months ago

commit e35dc28babb7e61342acb10eabd1fb4b5687a92d
parent 2fa3abbadcd1ba322e2b723a665eaa0385c53a98

2 files changed +7 -5

modified crates/radicle-node/src/reactor.rs

@@ -252,10 +252,10 @@ pub trait ReactionHandler: Send + Iterator<Item = Action<Self::Listener, Self::T

     /// [`ReactionHandler::handover_transport`] calls to the handler.
     fn transport_registered(&mut self, token: Token, transport: &Self::Transport);
     /// Method called by the reactor when a [`ReactionHandler::Command`] is received for the
     /// Method called by the reactor when a command is received for the
     /// [`ReactionHandler`].
     ///
     /// The commands are sent via [`Controller`] from outside of the reactor, including other
     /// The commands are sent via `Controller` from outside of the reactor, including other
     /// threads.
     fn handle_command(&mut self, cmd: wire::Control);

@@ -283,7 +283,7 @@ pub trait ReactionHandler: Send + Iterator<Item = Action<Self::Listener, Self::T

 /// High-level reactor API wrapping reactor [`Runtime`] into a thread and providing basic thread
 /// management for it.
 ///
 /// Apps running the [`Reactor`] can interface it and a [`ReactionHandler`] via use of the [`Controller`]
 /// Apps running the [`Reactor`] can interface it and a [`ReactionHandler`] via use of the `Controller`
 /// API.
 pub struct Reactor {
     thread: JoinHandle<()>,

@@ -327,7 +327,7 @@ impl Reactor {

         Ok(Self { thread, controller })
     }
     /// Provides a [`Controller`] that can be used to send events to
     /// Provides a `Controller` that can be used to send events to
     /// [`ReactionHandler`] via self.
     pub fn controller(&self) -> Controller {
         self.controller.clone()

modified crates/radicle-node/src/reactor/transport.rs

@@ -13,7 +13,9 @@ use crate::reactor::{EventHandler, WriteAtomic};

 const READ_BUFFER_SIZE: usize = u16::MAX as usize;
 /// An event happening for a [`Transport`] network transport and delivered to
 /// a [`crate::reactor::ReactionHandler`].
 /// a [`ReactionHandler`].
 ///
 /// [`ReactionHandler`]: crate::reactor::ReactionHandler
 pub enum SessionEvent<S: Session> {
     Established(S::Artifact),
     Data(Vec<u8>),