Skip to content

Commit

Permalink
fix: Add documentation for Direction enum and its variants
Browse files Browse the repository at this point in the history
  • Loading branch information
sanity committed Sep 21, 2024
1 parent 7d37ffa commit b26761a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/isotonic_regression.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@ struct Centroid<T: Coordinate> {
#[derive(Debug, Clone, Serialize)]
#[derive(PartialEq)]
#[allow(dead_code)]
/// Specifies the direction of the isotonic regression.
pub enum Direction {
/// Indicates an ascending (non-decreasing) regression.
Ascending,
/// Indicates a descending (non-increasing) regression.
Descending,
}

Expand Down

0 comments on commit b26761a

Please sign in to comment.