From bd88ead54fb83cec16c0f9936bbcf26c32900c83 Mon Sep 17 00:00:00 2001 From: Kyle Carow Date: Wed, 22 Jan 2025 16:35:17 -0700 Subject: [PATCH] minor doc tweaks --- src/lib.rs | 20 ++++++++++---------- src/n.rs | 2 +- src/traits.rs | 5 ++--- 3 files changed, 13 insertions(+), 14 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index a6cd885..06af21d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,18 +18,18 @@ //! See the [`Interpolator`] enum documentation for examples and notes on usage. //! -pub mod error; -pub mod n; -pub mod one; -pub mod three; -pub mod two; -pub mod traits; +mod error; +mod n; +mod one; +mod three; +mod two; +mod traits; pub use error::*; -pub use n::*; -pub use one::*; -pub use three::*; -pub use two::*; +pub(crate) use n::*; +pub(crate) use one::*; +pub(crate) use three::*; +pub(crate) use two::*; pub use traits::*; #[cfg(feature = "serde")] diff --git a/src/n.rs b/src/n.rs index 7890461..d3931f1 100644 --- a/src/n.rs +++ b/src/n.rs @@ -18,7 +18,7 @@ pub(crate) struct InterpND { impl InterpND { /// Interpolator dimensionality - pub fn ndim(&self) -> usize { + pub(crate) fn ndim(&self) -> usize { if self.values.len() == 1 { 0 } else { diff --git a/src/traits.rs b/src/traits.rs index b11eb13..5801437 100644 --- a/src/traits.rs +++ b/src/traits.rs @@ -2,10 +2,9 @@ use super::*; /// Methods applicable to all interpolators pub trait InterpMethods { - /// Validate data stored in [Self]. By design, [Self] can be instantiatated - /// only via the `new` method, which calls `validate`. + /// Validate data stored in [Self] fn validate(&self) -> Result<(), ValidationError>; - /// Interpolate at given point + /// Interpolate at supplied point fn interpolate(&self, point: &[f64]) -> Result; }