Skip to content

docs: restore section template comments in ndarray/base/diagonal and ndarray/last #11903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
May 4, 2026
+11 −1
Merged

docs: restore section template comments in ndarray/base/diagonal and ndarray/last #11903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1e32b8
docs: add missing section template comments in `ndarray/base/diagonal`
claude May 3, 2026
433e6fd
docs: restore canonical intro section comment in `ndarray/last`
claude May 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/diagonal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ limitations under the License.

> Return a view of the diagonal of a matrix (or stack of matrices).

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

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

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage
Expand Down Expand Up @@ -93,6 +97,8 @@ The function accepts the following arguments:

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

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

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples
Expand Down Expand Up @@ -141,6 +149,8 @@ console.log( ndarray2array( y ) );

<!-- /.examples -->

<!-- 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. -->

<section class="references">

</section>
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/last/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ limitations under the License.

> Return a read-only view of the last element (or subarray) along one or more [`ndarray`][@stdlib/ndarray/ctor] dimensions.

<!-- Section to include introductory text. Make sure to keep an empty line after the intro section element. -->
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

Expand Down