Skip to content

Commit 58cc64b

Browse files
committed
Add headings for more sections in ArrayBase docs
This more clearly separates the sections. By adding the headings to the Contents, this also makes the methods easier to discover.
1 parent ae13fd2 commit 58cc64b

File tree

4 files changed

+6
-2
lines changed

4 files changed

+6
-2
lines changed

src/impl_1d.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
//! Methods for one-dimensional arrays.
1111
use imp_prelude::*;
1212

13+
/// # Methods For 1-D Arrays
1314
impl<A, S> ArrayBase<S, Ix1>
1415
where S: Data<Elem=A>,
1516
{

src/impl_2d.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
//! Methods for two-dimensional arrays.
1111
use imp_prelude::*;
1212

13+
/// # Methods For 2-D Arrays
1314
impl<A, S> ArrayBase<S, Ix2>
1415
where S: Data<Elem=A>,
1516
{

src/lib.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,9 @@ pub type Ixs = isize;
240240
/// + [Conversions Between Array Types](#conversions-between-array-types)
241241
/// + [Constructor Methods for Owned Arrays](#constructor-methods-for-owned-arrays)
242242
/// + [Methods For All Array Types](#methods-for-all-array-types)
243-
///
243+
/// + [Methods For 1-D Arrays](#methods-for-1-d-arrays)
244+
/// + [Methods For 2-D Arrays](#methods-for-2-d-arrays)
245+
/// + [Numerical Methods for Arrays](#numerical-methods-for-arrays)
244246
///
245247
/// ## `Array`
246248
///

src/numeric/impl_numeric.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ use numeric_util;
1515

1616
use {FoldWhile, Zip};
1717

18-
/// Numerical methods for arrays.
18+
/// # Numerical Methods for Arrays
1919
impl<A, S, D> ArrayBase<S, D>
2020
where S: Data<Elem=A>,
2121
D: Dimension,

0 commit comments

Comments
 (0)