Skip to content

Commit 4b4b573

Browse files
PlaneshifterPlaneshifter
committed
Use ns for namespace variables and add comment
1 parent 6d64f5b commit 4b4b573

3 files changed

Lines changed: 38 additions & 34 deletions

File tree

‎lib/node_modules/@stdlib/error/tools/lib/index.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,47 +32,47 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
3232
/**
3333
* Top-level namespace.
3434
*
35-
* @namespace tools
35+
* @namespace ns
3636
*/
37-
var tools = {};
37+
var ns = {};
3838

3939
/**
4040
* @name database
41-
* @memberof tools
41+
* @memberof ns
4242
* @readonly
4343
* @type {Function}
4444
* @see {@link module:@stdlib/error/tools/database}
4545
*/
46-
setReadOnly( tools, 'database', require( '@stdlib/error/tools/database' ) );
46+
setReadOnly( ns, 'database', require( '@stdlib/error/tools/database' ) );
4747

4848
/**
4949
* @name formatProdErrorMessage
50-
* @memberof tools
50+
* @memberof ns
5151
* @readonly
5252
* @type {Function}
5353
* @see {@link module:@stdlib/error/tools/fmtprodmsg}
5454
*/
55-
setReadOnly( tools, 'formatProdErrorMessage', require( '@stdlib/error/tools/fmtprodmsg' ) );
55+
setReadOnly( ns, 'formatProdErrorMessage', require( '@stdlib/error/tools/fmtprodmsg' ) );
5656

5757
/**
5858
* @name id2pkg
59-
* @memberof tools
59+
* @memberof ns
6060
* @readonly
6161
* @type {Function}
6262
* @see {@link module:@stdlib/error/tools/id2pkg}
6363
*/
64-
setReadOnly( tools, 'id2pkg', require( '@stdlib/error/tools/id2pkg' ) );
64+
setReadOnly( ns, 'id2pkg', require( '@stdlib/error/tools/id2pkg' ) );
6565

6666
/**
6767
* @name pkg2id
68-
* @memberof tools
68+
* @memberof ns
6969
* @readonly
7070
* @type {Function}
7171
* @see {@link module:@stdlib/error/tools/pkg2id}
7272
*/
73-
setReadOnly( tools, 'pkg2id', require( '@stdlib/error/tools/pkg2id' ) );
73+
setReadOnly( ns, 'pkg2id', require( '@stdlib/error/tools/pkg2id' ) );
7474

7575

7676
// EXPORTS //
7777

78-
module.exports = tools;
78+
module.exports = ns;

‎lib/node_modules/@stdlib/math/base/tools/lib/index.js‎

Lines changed: 22 additions & 18 deletions
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: evalpoly-compile, evalrational-compile
27+
*/
28+
2529
// MODULES //
2630

2731
var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
@@ -32,18 +36,18 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
3236
/**
3337
* Top-level namespace.
3438
*
35-
* @namespace tools
39+
* @namespace ns
3640
*/
37-
var tools = {};
41+
var ns = {};
3842

3943
/**
4044
* @name continuedFraction
41-
* @memberof tools
45+
* @memberof ns
4246
* @readonly
4347
* @type {Function}
4448
* @see {@link module:@stdlib/math/base/tools/continued-fraction}
4549
*/
46-
setReadOnly( tools, 'continuedFraction', require( '@stdlib/math/base/tools/continued-fraction' ) );
50+
setReadOnly( ns, 'continuedFraction', require( '@stdlib/math/base/tools/continued-fraction' ) );
4751

4852
/**
4953
* @name evalpoly
@@ -52,63 +56,63 @@ setReadOnly( tools, 'continuedFraction', require( '@stdlib/math/base/tools/conti
5256
* @type {Function}
5357
* @see {@link module:@stdlib/math/base/tools/evalpoly}
5458
*/
55-
setReadOnly( tools, 'evalpoly', require( '@stdlib/math/base/tools/evalpoly' ) );
59+
setReadOnly( ns, 'evalpoly', require( '@stdlib/math/base/tools/evalpoly' ) );
5660

5761
/**
5862
* @name evalrational
59-
* @memberof tools
63+
* @memberof ns
6064
* @readonly
6165
* @type {Function}
6266
* @see {@link module:@stdlib/math/base/tools/evalrational}
6367
*/
64-
setReadOnly( tools, 'evalrational', require( '@stdlib/math/base/tools/evalrational' ) );
68+
setReadOnly( ns, 'evalrational', require( '@stdlib/math/base/tools/evalrational' ) );
6569

6670
/**
6771
* @name fibpoly
68-
* @memberof tools
72+
* @memberof ns
6973
* @readonly
7074
* @type {Function}
7175
* @see {@link module:@stdlib/math/base/tools/fibpoly}
7276
*/
73-
setReadOnly( tools, 'fibpoly', require( '@stdlib/math/base/tools/fibpoly' ) );
77+
setReadOnly( ns, 'fibpoly', require( '@stdlib/math/base/tools/fibpoly' ) );
7478

7579
/**
7680
* @name hermitepoly
77-
* @memberof tools
81+
* @memberof ns
7882
* @readonly
7983
* @type {Function}
8084
* @see {@link module:@stdlib/math/base/tools/hermitepoly}
8185
*/
82-
setReadOnly( tools, 'hermitepoly', require( '@stdlib/math/base/tools/hermitepoly' ) );
86+
setReadOnly( ns, 'hermitepoly', require( '@stdlib/math/base/tools/hermitepoly' ) );
8387

8488
/**
8589
* @name lucaspoly
86-
* @memberof tools
90+
* @memberof ns
8791
* @readonly
8892
* @type {Function}
8993
* @see {@link module:@stdlib/math/base/tools/lucaspoly}
9094
*/
91-
setReadOnly( tools, 'lucaspoly', require( '@stdlib/math/base/tools/lucaspoly' ) );
95+
setReadOnly( ns, 'lucaspoly', require( '@stdlib/math/base/tools/lucaspoly' ) );
9296

9397
/**
9498
* @name normhermitepoly
95-
* @memberof tools
99+
* @memberof ns
96100
* @readonly
97101
* @type {Function}
98102
* @see {@link module:@stdlib/math/base/tools/normhermitepoly}
99103
*/
100-
setReadOnly( tools, 'normhermitepoly', require( '@stdlib/math/base/tools/normhermitepoly' ) );
104+
setReadOnly( ns, 'normhermitepoly', require( '@stdlib/math/base/tools/normhermitepoly' ) );
101105

102106
/**
103107
* @name sumSeries
104-
* @memberof tools
108+
* @memberof ns
105109
* @readonly
106110
* @type {Function}
107111
* @see {@link module:@stdlib/math/base/tools/sum-series}
108112
*/
109-
setReadOnly( tools, 'sumSeries', require( '@stdlib/math/base/tools/sum-series' ) );
113+
setReadOnly( ns, 'sumSeries', require( '@stdlib/math/base/tools/sum-series' ) );
110114

111115

112116
// EXPORTS //
113117

114-
module.exports = tools;
118+
module.exports = ns;

‎lib/node_modules/@stdlib/string/tools/lib/index.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,20 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
3232
/**
3333
* Top-level namespace.
3434
*
35-
* @namespace tools
35+
* @namespace ns
3636
*/
37-
var tools = {};
37+
var ns = {};
3838

3939
/**
4040
* @name grapheme
41-
* @memberof tools
41+
* @memberof ns
4242
* @readonly
4343
* @type {Function}
4444
* @see {@link module:@stdlib/string/tools/grapheme-cluster-break}
4545
*/
46-
setReadOnly( tools, 'grapheme', require( '@stdlib/string/tools/grapheme-cluster-break' ) );
46+
setReadOnly( ns, 'grapheme', require( '@stdlib/string/tools/grapheme-cluster-break' ) );
4747

4848

4949
// EXPORTS //
5050

51-
module.exports = tools;
51+
module.exports = ns;

0 commit comments

Comments
 (0)