From 9d0aa722b511f54d4c3c576addc7d03c9e76183a Mon Sep 17 00:00:00 2001 From: "Franz Heinzmann (Frando)" Date: Tue, 4 Jun 2024 13:22:18 +0200 Subject: [PATCH] fix doc links --- iroh-docs/src/engine.rs | 5 +---- iroh/src/node.rs | 2 -- iroh/src/node/rpc/docs.rs | 2 +- 3 files changed, 2 insertions(+), 7 deletions(-) diff --git a/iroh-docs/src/engine.rs b/iroh-docs/src/engine.rs index 8df7dfd777..b5345b0bea 100644 --- a/iroh-docs/src/engine.rs +++ b/iroh-docs/src/engine.rs @@ -1,4 +1,4 @@ -//! Handlers and actors to for live syncing [`iroh_docs`] replicas. +//! Handlers and actors to for live syncing replicas. //! //! [`crate::Replica`] is also called documents here. @@ -40,9 +40,6 @@ const SUBSCRIBE_CHANNEL_CAP: usize = 256; /// The sync engine coordinates actors that manage open documents, set-reconciliation syncs with /// peers and a gossip swarm for each syncing document. -/// -/// The RPC methods dealing with documents and sync operate on the `Engine`, with method -/// implementations in [rpc]. #[derive(derive_more::Debug, Clone)] pub struct Engine { /// [`Endpoint`] used by the engine. diff --git a/iroh/src/node.rs b/iroh/src/node.rs index c510f5239c..7e0c6c2975 100644 --- a/iroh/src/node.rs +++ b/iroh/src/node.rs @@ -194,8 +194,6 @@ impl NodeInner { } /// Wrapper around [`Engine`] so that we can implement our RPC methods directly. -/// -/// See [`crate::node::rpc::docs`] #[derive(Debug, Clone)] pub(crate) struct DocsEngine(Engine); diff --git a/iroh/src/node/rpc/docs.rs b/iroh/src/node/rpc/docs.rs index 42f6fa0478..a0433a803e 100644 --- a/iroh/src/node/rpc/docs.rs +++ b/iroh/src/node/rpc/docs.rs @@ -1,4 +1,4 @@ -//! This module contains an impl block on [`Engine`] with handlers for RPC requests +//! This module contains an impl block on [`DocsEngine`] with handlers for RPC requests use anyhow::anyhow; use futures_lite::Stream;