Skip to content

Commit fdffa36

Browse files
PlaneshifterPlaneshifter
committed
Fix typo and add README.md skeleton
1 parent 1635ad4 commit fdffa36

2 files changed

Lines changed: 86 additions & 1 deletion

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The namespace contains the following sub-namespaces:
6464

6565
<!-- </toc> -->
6666

67-
In addition, the namespace contaians the following multidimensional array utility functions:
67+
In addition, the namespace contains the following multidimensional array utility functions:
6868

6969
<!-- <toc pattern="*" > -->
7070

‎lib/node_modules/@stdlib/ndarray/dispatch-by/README.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2023 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+
# Dispatch By
22+
23+
> Create an [ndarray][@stdlib/ndarray/ctor] function interface which accepts a callback function and performs multiple dispatch.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var dispatchBy = require( '@stdlib/ndarray/dispatch-by' );
37+
```
38+
39+
#### dispatchBy( fcns, types, data, nargs, nin, nout )
40+
41+
Creates an [ndarray][@stdlib/ndarray/ctor] function interface which accepts a callback function and performs multiple dispatch.
42+
43+
</section>
44+
45+
<!-- /.usage -->
46+
47+
<section class="notes">
48+
49+
</section>
50+
51+
<!-- /.notes -->
52+
53+
<section class="examples">
54+
55+
## Examples
56+
57+
<!-- eslint no-undef: "error" -->
58+
59+
```javascript
60+
var dispatchBy = require( '@stdlib/ndarray/dispatch-by' );
61+
```
62+
63+
</section>
64+
65+
<!-- /.examples -->
66+
67+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
68+
69+
<section class="related">
70+
71+
<!-- /.related -->
72+
73+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
74+
75+
<section class="links">
76+
77+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
78+
79+
<!-- <related-links> -->
80+
81+
<!-- </related-links> -->
82+
83+
</section>
84+
85+
<!-- /.links -->

0 commit comments

Comments
 (0)