Skip to content

Commit 01c94ca

Browse files
Sachinn-64Sachinn-64
committed
refactor: naming and conventions
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 5d74918 commit 01c94ca

11 files changed

Lines changed: 46 additions & 45 deletions

File tree

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/README.md

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

21-
# gridAligns
21+
# gridAlignments
2222

23-
> List of supported Vega grid aligns.
23+
> List of supported Vega 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,15 +37,15 @@ limitations under the License.
3737
## Usage
3838

3939
```javascript
40-
var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' );
40+
var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' );
4141
```
4242

43-
#### gridAligns()
43+
#### gridAlignments()
4444

45-
Returns a list of grid aligns.
45+
Returns a list of grid alignments.
4646

4747
```javascript
48-
var out = gridAligns();
48+
var out = gridAlignments();
4949
// returns [ 'all', 'each', 'none' ]
5050
```
5151

@@ -71,20 +71,20 @@ var out = gridAligns();
7171

7272
```javascript
7373
var contains = require( '@stdlib/array/base/assert/contains' ).factory;
74-
var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' );
74+
var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' );
7575

76-
var isGridAlign = contains( gridAligns() );
76+
var isGridAlignment = contains( gridAlignments() );
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( 'beep' );
84+
bool = isGridAlignment( 'beep' );
8585
// returns false
8686

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

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/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 isStringArray = require( '@stdlib/assert/is-string-array' ).primitives;
2525
var pkg = require( './../package.json' ).name;
26-
var gridAligns = require( './../lib' );
26+
var gridAlignments = require( './../lib' );
2727

2828

2929
// MAIN //
@@ -34,7 +34,7 @@ bench( pkg, function benchmark( b ) {
3434

3535
b.tic();
3636
for ( i = 0; i < b.iterations; i++ ) {
37-
out = gridAligns();
37+
out = gridAlignments();
3838
if ( out.length < 2 ) {
3939
b.fail( 'should return an array' );
4040
}

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/repl.txt renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/repl.txt

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

22
{{alias}}()
3-
Returns a list of grid aligns.
3+
Returns a list of grid alignments.
44

55
Returns
66
-------
77
out: Array<string>
8-
List of grid aligns.
8+
List of grid alignments.
99

1010
Examples
1111
--------

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/types/index.d.ts

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

2121
/**
22-
* Returns a list of grid aligns.
22+
* Returns a list of grid alignments.
2323
*
24-
* @returns list of grid aligns
24+
* @returns list of grid alignments
2525
*
2626
* @example
27-
* var list = gridAligns();
27+
* var list = gridAlignments();
2828
* // returns [ 'all', 'each', 'none' ]
2929
*/
30-
declare function gridAligns(): Array<string>;
30+
declare function gridAlignments(): Array<string>;
3131

3232

3333
// EXPORTS //
3434

35-
export = gridAligns;
35+
export = gridAlignments;

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/types/test.ts

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

19-
import gridAligns = require( './index' );
19+
import gridAlignments = require( './index' );
2020

2121

2222
// TESTS //
2323

2424
// The function returns an array of strings...
2525
{
26-
gridAligns(); // $ExpectType string[]
26+
gridAlignments(); // $ExpectType string[]
2727
}
2828

2929
// The compiler throws an error if the function is provided any arguments...
3030
{
31-
gridAligns( 9 ); // $ExpectError
31+
gridAlignments( 9 ); // $ExpectError
3232
}

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/examples/index.js

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

2121
var contains = require( '@stdlib/array/base/assert/contains' ).factory;
22-
var gridAligns = require( './../lib' );
22+
var gridAlignments = require( './../lib' );
2323

24-
var isGridAlign = contains( gridAligns() );
24+
var isGridAlignment = contains( gridAlignments() );
2525

26-
var bool = isGridAlign( 'all' );
26+
var bool = isGridAlignment( 'all' );
2727
console.log( bool );
2828
// => true
2929

30-
bool = isGridAlign( 'each' );
30+
bool = isGridAlignment( 'each' );
3131
console.log( bool );
3232
// => true
3333

34-
bool = isGridAlign( 'beep' );
34+
bool = isGridAlignment( 'beep' );
3535
console.log( bool );
3636
// => false
3737

38-
bool = isGridAlign( 'boop' );
38+
bool = isGridAlignment( 'boop' );
3939
console.log( bool );
4040
// => false

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/data.json renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/data.json

File renamed without changes.

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/index.js

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

2121
/**
22-
* Return a list of grid aligns.
22+
* Return a list of grid alignments.
2323
*
24-
* @module @stdlib/plot/vega/base/grid-aligns
24+
* @module @stdlib/plot/vega/base/grid-alignments
2525
*
2626
* @example
27-
* var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' );
27+
* var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' );
2828
*
29-
* var out = gridAligns();
29+
* var out = gridAlignments();
3030
* // returns [ 'all', 'each', 'none' ]
3131
*/
3232

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/main.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,19 @@ var DATA = require( './data.json' );
2626
// MAIN //
2727

2828
/**
29-
* Returns a list of grid aligns.
29+
* Returns a list of grid alignments.
3030
*
31-
* @returns {StringArray} list of grid aligns
31+
* @returns {StringArray} list of grid alignments
3232
*
3333
* @example
34-
* var out = gridAligns();
34+
* var out = gridAlignments();
3535
* // returns [ 'all', 'each', 'none' ]
3636
*/
37-
function gridAligns() {
37+
function gridAlignments() {
3838
return DATA.slice();
3939
}
4040

4141

4242
// EXPORTS //
4343

44-
module.exports = gridAligns;
44+
module.exports = gridAlignments;

lib/node_modules/@stdlib/plot/vega/base/grid-aligns/package.json renamed to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@stdlib/plot/vega/base/grid-aligns",
2+
"name": "@stdlib/plot/vega/base/grid-alignments",
33
"version": "0.0.0",
4-
"description": "List of supported Vega grid aligns.",
4+
"description": "List of supported Vega grid alignments.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",
@@ -53,6 +53,7 @@
5353
"plot",
5454
"vega",
5555
"grid",
56+
"alignment",
5657
"align",
5758
"layout",
5859
"utilities",

0 commit comments

Comments
 (0)