Skip to content

Commit

Permalink
fix doc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
cowlicks committed Oct 23, 2024
1 parent 242dcf5 commit 3ea4890
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions src/replication/events.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ use async_broadcast::{broadcast, InactiveReceiver, Receiver, Sender};

static MAX_EVENT_QUEUE_CAPACITY: usize = 32;

/// Event emeitted by [`Events::send_on_get`]
/// Event emitted by [`crate::Hypercore::event_subscribe`]
#[derive(Debug, Clone)]
/// Emitted when [`Hypercore::get`] is called when the block is missing.
/// Emitted when [`crate::Hypercore::get`] is called when the block is missing.
pub struct Get {
/// Index of the requested block
pub index: u64,
Expand Down
6 changes: 3 additions & 3 deletions src/replication/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ use std::future::Future;

/// Methods related to just this core's information
pub trait CoreInfo {
/// Get core info (see: [`Hypercore::info`]
/// Get core info (see: [`crate::Hypercore::info`]
fn info(&self) -> impl Future<Output = Info> + Send;
/// Get the key_pair (see: [`Hypercore::key_pair`]
/// Get the key_pair (see: [`crate::Hypercore::key_pair`]
fn key_pair(&self) -> impl Future<Output = PartialKeypair> + Send;
}

Expand Down Expand Up @@ -68,7 +68,7 @@ pub enum CoreMethodsError {
}

/// Trait for things that consume [`crate::Hypercore`] can instead use this trait
/// so they can use all Hypercore-like things such as [`SharedCore`].
/// so they can use all Hypercore-like things such as `SharedCore`.
pub trait CoreMethods: CoreInfo {
/// Check if the core has the block at the given index locally
fn has(&self, index: u64) -> impl Future<Output = bool> + Send;
Expand Down

0 comments on commit 3ea4890

Please sign in to comment.