Skip to content

Commit 952d1fa

Browse files
committed
Update namespace and table of contents
1 parent 5b969e1 commit 952d1fa

File tree

4 files changed

+80
-0
lines changed

4 files changed

+80
-0
lines changed

lib/node_modules/@stdlib/strided/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ The namespace contains the following:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`base`][@stdlib/strided/base]</span><span class="delimiter">: </span><span class="description">base strided.</span>
49+
- <span class="signature">[`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/strided/dispatch]</span><span class="delimiter">: </span><span class="description">create a strided array function interface which performs multiple dispatch.</span>
50+
- <span class="signature">[`dtypes()`][@stdlib/strided/dtypes]</span><span class="delimiter">: </span><span class="description">list of strided array data types.</span>
51+
52+
</div>
53+
4654
<!-- </toc> -->
4755

4856
</section>
@@ -72,6 +80,12 @@ console.log( objectKeys( ns ) );
7280

7381
<!-- <toc-links> -->
7482

83+
[@stdlib/strided/base]: https://github.com/stdlib-js/stdlib
84+
85+
[@stdlib/strided/dispatch]: https://github.com/stdlib-js/stdlib
86+
87+
[@stdlib/strided/dtypes]: https://github.com/stdlib-js/stdlib
88+
7589
<!-- </toc-links> -->
7690

7791
</section>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2021 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# Common
22+
23+
> Native strided array utilities.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var common = require( '@stdlib/strided/common' );
31+
```
32+
33+
#### common
34+
35+
</section>
36+
37+
<!-- /.usage -->
38+
39+
<section class="examples">
40+
41+
## Examples
42+
43+
<!-- TODO: better examples -->
44+
45+
<!-- eslint no-undef: "error" -->
46+
47+
```javascript
48+
var common = require( '@stdlib/strided/common' );
49+
50+
console.log( common );
51+
```
52+
53+
</section>
54+
55+
<!-- /.examples -->
56+
57+
<section class="links">
58+
59+
</section>
60+
61+
<!-- /.links -->

lib/node_modules/@stdlib/strided/lib/index.js

+4
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@
2222
* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
2323
*/
2424

25+
/*
26+
* The following modules are intentionally not exported: common, napi
27+
*/
28+
2529
// MODULES //
2630

2731
var setReadOnly = require( '@stdlib/utils/define-read-only-property' );

lib/node_modules/@stdlib/strided/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
"lib": "./lib",
2121
"test": "./test"
2222
},
23+
"types": "./docs/types",
2324
"scripts": {},
2425
"homepage": "https://github.com/stdlib-js/stdlib",
2526
"repository": {

0 commit comments

Comments
 (0)