Skip to content

Commit 86e9aee

Browse files
authored
docs: restore section template comments in ndarray/base/diagonal and ndarray/last
PR-URL: #11903 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 7d465f0 commit 86e9aee

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

lib/node_modules/@stdlib/ndarray/base/diagonal/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ limitations under the License.
2222

2323
> Return a view of the diagonal of a matrix (or stack of matrices).
2424
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
2527
<section class="intro">
2628

2729
For an `M`-by-`N` matrix `A`, the `k`-th diagonal is defined as
@@ -60,6 +62,8 @@ the main diagonal is `[ a_{0,0}, a_{1,1}, a_{2,2} ]`, the super-diagonal `k = 1`
6062

6163
<!-- /.intro -->
6264

65+
<!-- Package usage documentation. -->
66+
6367
<section class="usage">
6468

6569
## Usage
@@ -93,6 +97,8 @@ The function accepts the following arguments:
9397

9498
<!-- /.usage -->
9599

100+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
101+
96102
<section class="notes">
97103

98104
## Notes
@@ -107,6 +113,8 @@ The function accepts the following arguments:
107113

108114
<!-- /.notes -->
109115

116+
<!-- Package usage examples. -->
117+
110118
<section class="examples">
111119

112120
## Examples
@@ -141,6 +149,8 @@ console.log( ndarray2array( y ) );
141149

142150
<!-- /.examples -->
143151

152+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
153+
144154
<section class="references">
145155

146156
</section>

lib/node_modules/@stdlib/ndarray/last/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ limitations under the License.
2222

2323
> Return a read-only view of the last element (or subarray) along one or more [`ndarray`][@stdlib/ndarray/ctor] dimensions.
2424
25-
<!-- Section to include introductory text. Make sure to keep an empty line after the intro section element. -->
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

2727
<section class="intro">
2828

0 commit comments

Comments
 (0)