Skip to content

Commit 662256b

Browse files
Sachinn-64Sachinn-64
committed
refactor: naming conventions
1 parent c61f926 commit 662256b

10 files changed

Lines changed: 60 additions & 60 deletions

File tree

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/README.md renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ limitations under the License.
1818
1919
-->
2020

21-
# isGridAlign
21+
# isGridAlignment
2222

23-
> Test if an input value is a supported [grid align][@stdlib/plot/vega/base/grid-aligns].
23+
> Test if an input value is a supported [grid alignment][@stdlib/plot/vega/base/grid-alignments].
2424
2525
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

@@ -37,18 +37,18 @@ limitations under the License.
3737
## Usage
3838

3939
```javascript
40-
var isGridAlign = require( '@stdlib/plot/vega/base/assert/is-grid-align' );
40+
var isGridAlignment = require( '@stdlib/plot/vega/base/assert/is-grid-alignment' );
4141
```
4242

43-
#### isGridAlign( value )
43+
#### isGridAlignment( value )
4444

45-
Tests if an input value is a supported [grid align][@stdlib/plot/vega/base/grid-aligns].
45+
Tests if an input value is a supported [grid alignment][@stdlib/plot/vega/base/grid-alignments].
4646

4747
```javascript
48-
var bool = isGridAlign( 'all' );
48+
var bool = isGridAlignment( 'all' );
4949
// returns true
5050

51-
bool = isGridAlign( 'foo' );
51+
bool = isGridAlignment( 'foo' );
5252
// returns false
5353
```
5454

@@ -73,18 +73,18 @@ bool = isGridAlign( 'foo' );
7373
<!-- eslint no-undef: "error" -->
7474

7575
```javascript
76-
var isGridAlign = require( '@stdlib/plot/vega/base/assert/is-grid-align' );
76+
var isGridAlignment = require( '@stdlib/plot/vega/base/assert/is-grid-alignment' );
7777

78-
var bool = isGridAlign( 'all' );
78+
var bool = isGridAlignment( 'all' );
7979
// returns true
8080

81-
bool = isGridAlign( 'each' );
81+
bool = isGridAlignment( 'each' );
8282
// returns true
8383

84-
bool = isGridAlign( '' );
84+
bool = isGridAlignment( '' );
8585
// returns false
8686

87-
bool = isGridAlign( 'foo' );
87+
bool = isGridAlignment( 'foo' );
8888
// returns false
8989
```
9090

@@ -112,7 +112,7 @@ bool = isGridAlign( 'foo' );
112112

113113
<section class="links">
114114

115-
[@stdlib/plot/vega/base/grid-aligns]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/plot/vega/base/grid-aligns
115+
[@stdlib/plot/vega/base/grid-alignments]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/plot/vega/base/grid-alignments
116116

117117
</section>
118118

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/benchmark/benchmark.js renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/benchmark/benchmark.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
var bench = require( '@stdlib/bench' );
2424
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
2525
var pkg = require( './../package.json' ).name;
26-
var isGridAlign = require( './../lib' );
26+
var isGridAlignment = require( './../lib' );
2727

2828

2929
// MAIN //
@@ -48,7 +48,7 @@ bench( pkg, function benchmark( b ) {
4848
b.tic();
4949
for ( i = 0; i < b.iterations; i++ ) {
5050
v = values[ i%values.length ];
51-
out = isGridAlign( v );
51+
out = isGridAlignment( v );
5252
if ( typeof out !== 'boolean' ) {
5353
b.fail( 'should return a boolean' );
5454
}

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/docs/repl.txt renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( value )
3-
Tests if an input value is a supported grid align.
3+
Tests if an input value is a supported grid alignment.
44

55
Parameters
66
----------
@@ -10,7 +10,7 @@
1010
Returns
1111
-------
1212
bool: boolean
13-
Boolean indicating if an input value is a supported grid align.
13+
Boolean indicating if an input value is a supported grid alignment.
1414

1515
Examples
1616
--------

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/docs/types/index.d.ts renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/docs/types/index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,27 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Tests whether an input value is a supported grid align.
22+
* Tests whether an input value is a supported grid alignment.
2323
*
2424
* @param v - value to test
25-
* @returns boolean indicating whether an input value is a supported grid align
25+
* @returns boolean indicating whether an input value is a supported grid alignment
2626
*
2727
* @example
28-
* var bool = isGridAlign( 'all' );
28+
* var bool = isGridAlignment( 'all' );
2929
* // returns true
3030
*
31-
* bool = isGridAlign( 'each' );
31+
* bool = isGridAlignment( 'each' );
3232
* // returns true
3333
*
34-
* bool = isGridAlign( 'bar' );
34+
* bool = isGridAlignment( 'bar' );
3535
* // returns false
3636
*
37-
* bool = isGridAlign( 'foo' );
37+
* bool = isGridAlignment( 'foo' );
3838
* // returns false
3939
*/
40-
declare function isGridAlign( v: any ): boolean;
40+
declare function isGridAlignment( v: any ): boolean;
4141

4242

4343
// EXPORTS //
4444

45-
export = isGridAlign;
45+
export = isGridAlignment;

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/docs/types/test.ts renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/docs/types/test.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@
1616
* limitations under the License.
1717
*/
1818

19-
import isGridAlign = require( './index' );
19+
import isGridAlignment = require( './index' );
2020

2121

2222
// TESTS //
2323

2424
// The function returns a boolean...
2525
{
26-
isGridAlign( 'all' ); // $ExpectType boolean
27-
isGridAlign( 'foo' ); // $ExpectType boolean
26+
isGridAlignment( 'all' ); // $ExpectType boolean
27+
isGridAlignment( 'foo' ); // $ExpectType boolean
2828
}
2929

3030
// The compiler throws an error if the function is provided an unsupported number of arguments...
3131
{
32-
isGridAlign(); // $ExpectError
33-
isGridAlign( undefined, 123 ); // $ExpectError
32+
isGridAlignment(); // $ExpectError
33+
isGridAlignment( undefined, 123 ); // $ExpectError
3434
}

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/examples/index.js renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/examples/index.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@
1818

1919
'use strict';
2020

21-
var isGridAlign = require( './../lib' );
21+
var isGridAlignment = require( './../lib' );
2222

23-
var bool = isGridAlign( 'all' );
23+
var bool = isGridAlignment( 'all' );
2424
console.log( bool );
2525
// => true
2626

27-
bool = isGridAlign( 'each' );
27+
bool = isGridAlignment( 'each' );
2828
console.log( bool );
2929
// => true
3030

31-
bool = isGridAlign( '' );
31+
bool = isGridAlignment( '' );
3232
console.log( bool );
3333
// => false
3434

35-
bool = isGridAlign( 'foo' );
35+
bool = isGridAlignment( 'foo' );
3636
console.log( bool );
3737
// => false

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/lib/index.js renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/lib/index.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,23 @@
1919
'use strict';
2020

2121
/**
22-
* Test whether an input value is a supported grid align.
22+
* Test whether an input value is a supported grid alignment.
2323
*
24-
* @module @stdlib/plot/vega/base/assert/is-grid-align
24+
* @module @stdlib/plot/vega/base/assert/is-grid-alignment
2525
*
2626
* @example
27-
* var isGridAlign = require( '@stdlib/plot/vega/base/assert/is-grid-align' );
27+
* var isGridAlignment = require( '@stdlib/plot/vega/base/assert/is-grid-alignment' );
2828
*
29-
* var bool = isGridAlign( 'all' );
29+
* var bool = isGridAlignment( 'all' );
3030
* // returns true
3131
*
32-
* bool = isGridAlign( 'each' );
32+
* bool = isGridAlignment( 'each' );
3333
* // returns true
3434
*
35-
* bool = isGridAlign( 'bar' );
35+
* bool = isGridAlignment( 'bar' );
3636
* // returns false
3737
*
38-
* bool = isGridAlign( 'foo' );
38+
* bool = isGridAlignment( 'foo' );
3939
* // returns false
4040
*/
4141

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/lib/main.js renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/lib/main.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,35 @@
2121
// MODULES //
2222

2323
var contains = require( '@stdlib/array/base/assert/contains' ).factory;
24-
var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' );
24+
var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' );
2525

2626

2727
// MAIN //
2828

2929
/**
30-
* Tests whether an input value is a supported grid align.
30+
* Tests whether an input value is a supported grid alignment.
3131
*
32-
* @name isGridAlign
32+
* @name isGridAlignment
3333
* @type {Function}
3434
* @param {*} v - value to test
35-
* @returns {boolean} boolean indicating whether an input value is a supported grid align
35+
* @returns {boolean} boolean indicating whether an input value is a supported grid alignment
3636
*
3737
* @example
38-
* var bool = isGridAlign( 'all' );
38+
* var bool = isGridAlignment( 'all' );
3939
* // returns true
4040
*
41-
* bool = isGridAlign( 'each' );
41+
* bool = isGridAlignment( 'each' );
4242
* // returns true
4343
*
44-
* bool = isGridAlign( 'bar' );
44+
* bool = isGridAlignment( 'bar' );
4545
* // returns false
4646
*
47-
* bool = isGridAlign( 'foo' );
47+
* bool = isGridAlignment( 'foo' );
4848
* // returns false
4949
*/
50-
var isGridAlign = contains( gridAligns() );
50+
var isGridAlignment = contains( gridAlignments() );
5151

5252

5353
// EXPORTS //
5454

55-
module.exports = isGridAlign;
55+
module.exports = isGridAlignment;

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/package.json renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@stdlib/plot/vega/base/assert/is-grid-align",
2+
"name": "@stdlib/plot/vega/base/assert/is-grid-alignment",
33
"version": "0.0.0",
4-
"description": "Test if an input value is a supported grid align.",
4+
"description": "Test if an input value is a supported grid alignment.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-align/test/test.js renamed to lib/node_modules/@stdlib/plot/vega/base/assert/is-grid-alignment/test/test.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@
2121
// MODULES //
2222

2323
var tape = require( 'tape' );
24-
var isGridAlign = require( './../lib' );
24+
var isGridAlignment = require( './../lib' );
2525

2626

2727
// TESTS //
2828

2929
tape( 'main export is a function', function test( t ) {
3030
t.ok( true, __filename );
31-
t.strictEqual( typeof isGridAlign, 'function', 'main export is a function' );
31+
t.strictEqual( typeof isGridAlignment, 'function', 'main export is a function' );
3232
t.end();
3333
});
3434

35-
tape( 'the function returns `true` if provided a supported grid align', function test( t ) {
35+
tape( 'the function returns `true` if provided a supported grid alignment', function test( t ) {
3636
var values;
3737
var bool;
3838
var i;
@@ -43,13 +43,13 @@ tape( 'the function returns `true` if provided a supported grid align', function
4343
'none'
4444
];
4545
for ( i = 0; i < values.length; i++ ) {
46-
bool = isGridAlign( values[ i ] );
46+
bool = isGridAlignment( values[ i ] );
4747
t.strictEqual( bool, true, 'returns expected value when provided '+values[ i ] );
4848
}
4949
t.end();
5050
});
5151

52-
tape( 'the function returns `false` if not provided a supported grid align', function test( t ) {
52+
tape( 'the function returns `false` if not provided a supported grid alignment', function test( t ) {
5353
var values;
5454
var bool;
5555
var i;
@@ -71,7 +71,7 @@ tape( 'the function returns `false` if not provided a supported grid align', fun
7171
function noop() {}
7272
];
7373
for ( i = 0; i < values.length; i++ ) {
74-
bool = isGridAlign( values[ i ] );
74+
bool = isGridAlignment( values[ i ] );
7575
t.strictEqual( bool, false, 'returns expected value when provided '+values[ i ] );
7676
}
7777
t.end();

0 commit comments

Comments
 (0)