Skip to content

Commit f0aa308

Browse files
kgrytekgryte
committed
Update namespace descriptions
1 parent e61e6f1 commit f0aa308

File tree

157 files changed

+253
-253
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+253
-253
lines changed

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Assert
2222

23-
> Standard library assertion utilities.
23+
> Assertion utilities.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var assert = require( '@stdlib/assert' );
3232

3333
#### assert
3434

35-
Included in this namespace is a comprehensive suite of assertion utilities, such as utilities for testing for various data types and others for testing for JavaScript feature support.
35+
Namespace providing utilities for data type testing and feature detection.
3636

3737
```javascript
3838
var o = assert;
@@ -154,7 +154,7 @@ The namespace also contains utilities to test for numbers within a certain range
154154

155155
<!-- </toc> -->
156156

157-
The namespace provides various utilities for validating typed arrays:
157+
The namespace provides utilities for validating typed arrays:
158158

159159
<!-- <toc pattern="is-+(int8|int16|int32|uint8clamped|uint8|uint16|uint32|float32|float64)array"> -->
160160

‎lib/node_modules/@stdlib/assert/tools/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Assert
2222

23-
> Standard library assertion utility tools.
23+
> Assertion utility tools.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var tools = require( '@stdlib/assert/tools' );
3232

3333
#### tools
3434

35-
Standard library assertion utility tools.
35+
Namespace for assertion utility tools.
3636

3737
```javascript
3838
var o = tools;

‎lib/node_modules/@stdlib/assert/tools/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ interface Namespace {
118118
}
119119

120120
/**
121-
* Standard library assertion utility tools.
121+
* Assertion utility tools.
122122
*/
123123
declare var ns: Namespace;
124124

‎lib/node_modules/@stdlib/assert/tools/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/assert/tools",
33
"version": "0.0.0",
4-
"description": "Standard library assertion utility tools.",
4+
"description": "Assertion utility tools.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# BLAS
2222

23-
> Standard library basic linear algebra subprograms (BLAS).
23+
> Basic linear algebra subprograms (BLAS).
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var blas = require( '@stdlib/blas' );
3232

3333
#### blas
3434

35-
Standard library basic linear algebra subprograms (BLAS).
35+
Namespace for basic linear algebra subprograms (BLAS).
3636

3737
```javascript
3838
var o = blas;
@@ -45,7 +45,7 @@ The namespace contains the following:
4545

4646
<div class="namespace-toc">
4747

48-
- <span class="signature">[`base`][@stdlib/blas/base]</span><span class="delimiter">: </span><span class="description">standard library base reference basic linear algebra subprograms (BLAS).</span>
48+
- <span class="signature">[`base`][@stdlib/blas/base]</span><span class="delimiter">: </span><span class="description">"base" (i.e., lower-level) basic linear algebra subprograms (BLAS).</span>
4949
- <span class="signature">[`ddot( x, y )`][@stdlib/blas/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two double-precision floating-point vectors.</span>
5050
- <span class="signature">[`dswap( x, y )`][@stdlib/blas/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
5151
- <span class="signature">[`ext`][@stdlib/blas/ext]</span><span class="delimiter">: </span><span class="description">standard library extended basic linear algebra subprograms (BLAS).</span>

‎lib/node_modules/@stdlib/blas/base/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# BLAS
2222

23-
> Standard library base reference basic linear algebra subprograms (BLAS).
23+
> Base (i.e., lower-level) basic linear algebra subprograms (BLAS).
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var blas = require( '@stdlib/blas/base' );
3232

3333
#### blas
3434

35-
Base reference basic linear algebra subprograms (BLAS).
35+
Namespace for "base" (i.e., lower-level) basic linear algebra subprograms (BLAS).
3636

3737
```javascript
3838
var o = blas;

‎lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -810,7 +810,7 @@ interface Namespace {
810810
}
811811

812812
/**
813-
* Standard library basic linear algebra subprograms (BLAS).
813+
* "Base" (i.e., lower-level) basic linear algebra subprograms (BLAS).
814814
*/
815815
declare var ns: Namespace;
816816

‎lib/node_modules/@stdlib/blas/base/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/blas/base",
33
"version": "0.0.0",
4-
"description": "Standard library basic linear algebra subprograms (BLAS).",
4+
"description": "Base (i.e., lower-level) basic linear algebra subprograms (BLAS).",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

‎lib/node_modules/@stdlib/blas/docs/types/index.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import sswap = require( '@stdlib/blas/sswap' );
3535
*/
3636
interface Namespace {
3737
/**
38-
* Standard library basic linear algebra subprograms (BLAS).
38+
* "Base" (i.e., lower-level) basic linear algebra subprograms (BLAS).
3939
*/
4040
base: typeof base;
4141

@@ -191,7 +191,7 @@ interface Namespace {
191191
}
192192

193193
/**
194-
* Standard library BLAS.
194+
* BLAS.
195195
*/
196196
declare var ns: Namespace;
197197

‎lib/node_modules/@stdlib/blas/ext/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Extended BLAS
2222

23-
> Standard library extended basic linear algebra subprograms (BLAS).
23+
> Extended basic linear algebra subprograms (BLAS).
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var extblas = require( '@stdlib/blas/ext' );
3232

3333
#### extblas
3434

35-
Standard library extended basic linear algebra subprograms (BLAS).
35+
Namespace for extended basic linear algebra subprograms (BLAS).
3636

3737
```javascript
3838
var o = extblas;

‎lib/node_modules/@stdlib/blas/ext/base/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Extended BLAS
2222

23-
> Standard library extensions to base basic linear algebra subprograms (BLAS).
23+
> Base (i.e., lower-level) extensions to basic linear algebra subprograms (BLAS).
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var extblas = require( '@stdlib/blas/ext/base' );
3232

3333
#### extblas
3434

35-
Standard library extensions to base basic linear algebra subprograms (BLAS).
35+
Namespace for "base" (i.e., lower-level) extensions to basic linear algebra subprograms (BLAS).
3636

3737
```javascript
3838
var ns = extblas;

‎lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3273,7 +3273,7 @@ interface Namespace {
32733273
}
32743274

32753275
/**
3276-
* Standard library extended basic linear algebra subroutines (BLAS).
3276+
* Base (i.e., lower-level) extensions to basic linear algebra subroutines (BLAS).
32773277
*/
32783278
declare var ns: Namespace;
32793279

‎lib/node_modules/@stdlib/blas/ext/base/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/blas/ext/base",
33
"version": "0.0.0",
4-
"description": "Standard library extended basic linear algebra subroutines (BLAS).",
4+
"description": "Extended base (i.e., lower-level) basic linear algebra subroutines (BLAS).",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

‎lib/node_modules/@stdlib/blas/ext/docs/types/index.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ import base = require( '@stdlib/blas/ext/base' );
2828
*/
2929
interface Namespace {
3030
/**
31-
* Standard library extended basic linear algebra subroutines (BLAS).
31+
* Base (i.e., lower-level) extensions to basic linear algebra subroutines (BLAS).
3232
*/
3333
base: typeof base;
3434
}
3535

3636
/**
37-
* Standard library extended BLAS.
37+
* Extended BLAS.
3838
*/
3939
declare var ns: Namespace;
4040

‎lib/node_modules/@stdlib/blas/ext/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/blas/ext",
33
"version": "0.0.0",
4-
"description": "Standard library extended BLAS.",
4+
"description": "Extended BLAS.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

‎lib/node_modules/@stdlib/blas/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/blas",
33
"version": "0.0.0",
4-
"description": "Standard library BLAS.",
4+
"description": "BLAS.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Constants
2222

23-
> Standard library constants.
23+
> Constants.
2424
2525
<section class="usage">
2626

@@ -32,14 +32,14 @@ var constants = require( '@stdlib/constants' );
3232

3333
#### constants
3434

35-
Standard library constants.
35+
Namespace containing constants.
3636

3737
```javascript
3838
var ns = constants;
3939
// returns {...}
4040
```
4141

42-
The constants that are part of this package live in the following sub-namespaces:
42+
Constants are split across the the following sub-namespaces:
4343

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

‎lib/node_modules/@stdlib/constants/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ interface Namespace {
8787
int32: typeof int32;
8888

8989
/**
90-
* Standard string path constants.
90+
* Path constants.
9191
*/
9292
path: typeof path;
9393

@@ -112,13 +112,13 @@ interface Namespace {
112112
uint32: typeof uint32;
113113

114114
/**
115-
* Standard string unicode constants.
115+
* String unicode constants.
116116
*/
117117
unicode: typeof unicode;
118118
}
119119

120120
/**
121-
* Standard library constants.
121+
* Constants.
122122
*/
123123
declare var ns: Namespace;
124124

‎lib/node_modules/@stdlib/constants/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/constants",
33
"version": "0.0.0",
4-
"description": "Standard library constants.",
4+
"description": "Constants.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

‎lib/node_modules/@stdlib/constants/path/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ limitations under the License.
1818
1919
-->
2020

21-
# String Path Constants
21+
# Path Constants
2222

23-
> Standard library string path constants.
23+
> Path constants.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var constants = require( '@stdlib/constants/path' );
3232

3333
#### constants
3434

35-
Standard library string path constants.
35+
Namespace containing path constants.
3636

3737
```javascript
3838
var ns = constants;

‎lib/node_modules/@stdlib/constants/unicode/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ limitations under the License.
1818
1919
-->
2020

21-
# String Unicode Constants
21+
# Unicode Constants
2222

23-
> Standard library string unicode constants.
23+
> Unicode constants.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var constants = require( '@stdlib/constants/unicode' );
3232

3333
#### constants
3434

35-
Standard library string unicode constants.
35+
Namespace containing Unicode constants.
3636

3737
```javascript
3838
var ns = constants;

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Datasets
2222

23-
> Standard library datasets.
23+
> Datasets.
2424
2525
<section class="usage">
2626

‎lib/node_modules/@stdlib/datasets/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/datasets",
33
"version": "0.0.0",
4-
"description": "Standard library datasets.",
4+
"description": "Datasets.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Filesystem
2222

23-
> Standard library for interfacing with a filesystem.
23+
> Filesystem APIs.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var fs = require( '@stdlib/fs' );
3232

3333
#### fs
3434

35-
Standard library for interfacing with a filesystem.
35+
Namespace for filesystem APIs.
3636

3737
```javascript
3838
var f = fs;

‎lib/node_modules/@stdlib/fs/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ interface Namespace {
412412
}
413413

414414
/**
415-
* Standard library for interfacing with a fileystem.
415+
* Filesystem APIs.
416416
*/
417417
declare var ns: Namespace;
418418

‎lib/node_modules/@stdlib/fs/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/fs",
33
"version": "0.0.0",
4-
"description": "Standard library for interfacing with a fileystem.",
4+
"description": "Filesystem APIs.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)