Skip to content

Commit b490cd7

Browse files
authored
Merge pull request #601 from JP-Ellis/improve-documentation
Improve documentation for sum_axis and mean_axis
2 parents 4bdd185 + 869d3a9 commit b490cd7

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

src/numeric/impl_numeric.rs

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,13 @@ impl<A, S, D> ArrayBase<S, D>
8888
/// ```
8989
/// use ndarray::{aview0, aview1, arr2, Axis};
9090
///
91-
/// let a = arr2(&[[1., 2.],
92-
/// [3., 4.]]);
91+
/// let a = arr2(&[[1., 2., 3.],
92+
/// [4., 5., 6.]]);
9393
/// assert!(
94-
/// a.sum_axis(Axis(0)) == aview1(&[4., 6.]) &&
95-
/// a.sum_axis(Axis(1)) == aview1(&[3., 7.]) &&
94+
/// a.sum_axis(Axis(0)) == aview1(&[5., 7., 9.]) &&
95+
/// a.sum_axis(Axis(1)) == aview1(&[6., 15.]) &&
9696
///
97-
/// a.sum_axis(Axis(0)).sum_axis(Axis(0)) == aview0(&10.)
97+
/// a.sum_axis(Axis(0)).sum_axis(Axis(0)) == aview0(&21.)
9898
/// );
9999
/// ```
100100
///
@@ -128,13 +128,15 @@ impl<A, S, D> ArrayBase<S, D>
128128
/// fails for the axis length.
129129
///
130130
/// ```
131-
/// use ndarray::{aview1, arr2, Axis};
131+
/// use ndarray::{aview0, aview1, arr2, Axis};
132132
///
133-
/// let a = arr2(&[[1., 2.],
134-
/// [3., 4.]]);
133+
/// let a = arr2(&[[1., 2., 3.],
134+
/// [4., 5., 6.]]);
135135
/// assert!(
136-
/// a.mean_axis(Axis(0)) == aview1(&[2.0, 3.0]) &&
137-
/// a.mean_axis(Axis(1)) == aview1(&[1.5, 3.5])
136+
/// a.mean_axis(Axis(0)) == aview1(&[2.5, 3.5, 4.5]) &&
137+
/// a.mean_axis(Axis(1)) == aview1(&[2., 5.]) &&
138+
///
139+
/// a.mean_axis(Axis(0)).mean_axis(Axis(0)) == aview0(&3.5)
138140
/// );
139141
/// ```
140142
pub fn mean_axis(&self, axis: Axis) -> Array<A, D::Smaller>

0 commit comments

Comments
 (0)