Skip to content

Commit 0916231

Browse files
committed
Disable doc-tests of private functions
1 parent cda1cea commit 0916231

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

splashsurf_lib/src/uniform_grid.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,7 @@ impl Direction {
710710
}
711711

712712
/// Adds or subtracts the given step from the value depending on the direction
713-
/// ```
713+
/// ```ignore
714714
/// use crate::splashsurf_lib::uniform_grid::Direction;
715715
/// assert_eq!(Direction::Positive.apply_step(27, 3), 30);
716716
/// assert_eq!(Direction::Negative.apply_step(27, 3), 24);
@@ -725,7 +725,7 @@ impl Direction {
725725
}
726726

727727
/// Same as `apply_step` but uses `checked_add` and `checked_sub`, i.e. returns `None` on overflow
728-
/// ```
728+
/// ```ignore
729729
/// use crate::splashsurf_lib::uniform_grid::Direction;
730730
/// assert_eq!(Direction::Negative.checked_apply_step(0 as i32, 10), Some(-10));
731731
/// assert_eq!(Direction::Negative.checked_apply_step(0 as u32, 10), None);
@@ -744,7 +744,7 @@ impl Direction {
744744
}
745745

746746
/// Returns whether the direction is positive
747-
/// ```
747+
/// ```ignore
748748
/// use crate::splashsurf_lib::uniform_grid::Direction;
749749
/// assert_eq!(Direction::Positive.is_positive(), true);
750750
/// assert_eq!(Direction::Negative.is_positive(), false);
@@ -755,7 +755,7 @@ impl Direction {
755755
}
756756

757757
/// Returns whether the direction is negative
758-
/// ```
758+
/// ```ignore
759759
/// use crate::splashsurf_lib::uniform_grid::Direction;
760760
/// assert_eq!(Direction::Positive.is_negative(), false);
761761
/// assert_eq!(Direction::Negative.is_negative(), true);
@@ -770,7 +770,7 @@ const ALL_DIRECTIONS: [Direction; 2] = [Direction::Negative, Direction::Positive
770770

771771
impl CartesianAxis3d {
772772
/// Converts the cartesian axis into the 3D dimension index (X=0, Y=1, Z=2)
773-
/// ```
773+
/// ```ignore
774774
/// use crate::splashsurf_lib::uniform_grid::CartesianAxis3d as Axis;
775775
/// assert_eq!(Axis::X.dim(), 0);
776776
/// assert_eq!(Axis::Y.dim(), 1);
@@ -782,7 +782,7 @@ impl CartesianAxis3d {
782782
}
783783

784784
/// Returns the other two axes that are orthogonal to the current axis
785-
/// ```
785+
/// ```ignore
786786
/// use crate::splashsurf_lib::uniform_grid::CartesianAxis3d as Axis;
787787
/// assert_eq!(Axis::X.orthogonal_axes(), [Axis::Y, Axis::Z]);
788788
/// ```

0 commit comments

Comments
 (0)