Skip to content

Commit dca300a

Browse files
committed
doc: Slight tweaks to the introduction paragraphs of ArrayBase
1 parent ebe9e98 commit dca300a

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/lib.rs

+8-4
Original file line numberDiff line numberDiff line change
@@ -231,9 +231,13 @@ pub type Ixs = isize;
231231

232232
/// An *n*-dimensional array.
233233
///
234-
/// The array is a general container of elements. It cannot grow or shrink (with some exceptions),
235-
/// but can be sliced into subsets of its data.
236-
/// The array supports arithmetic operations by applying them elementwise.
234+
/// The array is a general container of elements.
235+
/// The array supports arithmetic operations by applying them elementwise, if the
236+
/// elements are numeric, but it supports non-numeric elements too.
237+
///
238+
/// The arrays rarely grow or shrink, since those operations can be costly. On
239+
/// the other hand there is a rich set of methods and operations for taking views,
240+
/// slices, and making traversals over one or more arrays.
237241
///
238242
/// In *n*-dimensional we include for example 1-dimensional rows or columns,
239243
/// 2-dimensional matrices, and higher dimensional arrays. If the array has *n*
@@ -244,7 +248,7 @@ pub type Ixs = isize;
244248
///
245249
/// Type aliases [`Array`], [`ArcArray`], [`CowArray`], [`ArrayView`], and
246250
/// [`ArrayViewMut`] refer to `ArrayBase` with different types for the data
247-
/// container.
251+
/// container: arrays with different kinds of ownership or different kinds of array views.
248252
///
249253
/// ## Contents
250254
///

0 commit comments

Comments
 (0)