Skip to content

Commit ad293af

Browse files
committed
Edit docs for fold_axis
1 parent b588a24 commit ad293af

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/impl_methods.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1260,7 +1260,12 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
12601260
}
12611261
}
12621262

1263-
/// Fold along an axis
1263+
/// Fold along an axis.
1264+
///
1265+
/// Combine the elements of each subview with the previous using the `fold`
1266+
/// function and initial value `init`.
1267+
///
1268+
/// Return the result as an `OwnedArray`.
12641269
pub fn fold_axis<B, F>(&self, axis: Axis, init: B, mut fold: F)
12651270
-> OwnedArray<B, D::Smaller>
12661271
where D: RemoveAxis,

0 commit comments

Comments
 (0)