Skip to content

Commit

Permalink
minor doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
kylecarow committed Jan 22, 2025
1 parent 2d73fcf commit bd88ead
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 14 deletions.
20 changes: 10 additions & 10 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/n.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
5 changes: 2 additions & 3 deletions src/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<f64, InterpolationError>;
}

Expand Down

0 comments on commit bd88ead

Please sign in to comment.