docs: fix broken intra-doc links; make cargo doc clean
This commit is contained in:
@@ -4,7 +4,7 @@
|
|||||||
//! bit positions per inserted `ObservationId`. The `salt` value mixes into the
|
//! bit positions per inserted `ObservationId`. The `salt` value mixes into the
|
||||||
//! hash so that the same id under different salts lands on different bit
|
//! hash so that the same id under different salts lands on different bit
|
||||||
//! positions, keeping false positives between independent filters low. The
|
//! positions, keeping false positives between independent filters low. The
|
||||||
//! hashing scheme is pinned (see [`positions`]) so that `tines-core` and the
|
//! hashing scheme is pinned (see `positions`) so that `tines-core` and the
|
||||||
//! simulation agree bit-for-bit across builds.
|
//! simulation agree bit-for-bit across builds.
|
||||||
//!
|
//!
|
||||||
//! This type is `core`-only: it owns a fixed `[u8; SUMMARY_BYTES]` array and
|
//! This type is `core`-only: it owns a fixed `[u8; SUMMARY_BYTES]` array and
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
//! In-memory observation store backed by a `BTreeMap` keyed by content-derived
|
//! In-memory observation store backed by a `BTreeMap` keyed by content-derived
|
||||||
//! `ObservationId`.
|
//! `ObservationId`.
|
||||||
//!
|
//!
|
||||||
//! `MemStore` implements [`Store`](crate::store::Store). It is unbounded, so it
|
//! `MemStore` implements [`Store`]. It is unbounded, so it
|
||||||
//! never returns `StoreError::Full`; allocation is therefore required and the
|
//! never returns `StoreError::Full`; allocation is therefore required and the
|
||||||
//! module is gated behind the `alloc` feature.
|
//! module is gated behind the `alloc` feature.
|
||||||
|
|
||||||
|
|||||||
@@ -102,7 +102,7 @@ impl<S: Store, T: Transport> Node<S, T> {
|
|||||||
/// observations, then emits at most one outbound frame.
|
/// observations, then emits at most one outbound frame.
|
||||||
///
|
///
|
||||||
/// Returns the number of *new* observations stored this round. A
|
/// Returns the number of *new* observations stored this round. A
|
||||||
/// [`tines_core::transport::SendError`] is ignored: the observation stays
|
/// [`crate::transport::SendError`] is ignored: the observation stays
|
||||||
/// queued only when the transport was `Busy`, otherwise it is dropped and
|
/// queued only when the transport was `Busy`, otherwise it is dropped and
|
||||||
/// re-queued by the next summary round.
|
/// re-queued by the next summary round.
|
||||||
pub fn poll(&mut self, now: Tick) -> usize {
|
pub fn poll(&mut self, now: Tick) -> usize {
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
//! Sim: a reference-counted harness over a shared `SimWorld`.
|
//! Sim: a reference-counted harness over a shared `SimWorld`.
|
||||||
//!
|
//!
|
||||||
//! `Sim` drives the world and its `Node`s as a discrete time-step machine. Each
|
//! `Sim` drives the world and its `Node`s as a discrete time-step machine. Each
|
||||||
//! [`Self::step`] advances the clock, asks the world to emit any `Contact`/`Lost`
|
//! [`Sim::step`] advances the clock, asks the world to emit any `Contact`/`Lost`
|
||||||
//! events, and polls every node once. Peers discover each other through those
|
//! events, and polls every node once. Peers discover each other through those
|
||||||
//! events and exchange summaries; the harness exposes convenience views over the
|
//! events and exchange summaries; the harness exposes convenience views over the
|
||||||
//! resulting state (the per-node id set, global convergence, and the components
|
//! resulting state (the per-node id set, global convergence, and the components
|
||||||
|
|||||||
Reference in New Issue
Block a user