Skip to content

Commit 004ecc4

Browse files
committed
docs: minor clean-up
--- 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: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - 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: na - task: lint_license_headers status: passed ---
1 parent 46ff8ea commit 004ecc4

File tree

12 files changed

+27
-14
lines changed

12 files changed

+27
-14
lines changed

lib/node_modules/@stdlib/constants/int8/max/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var INT8_MAX = require( '@stdlib/constants/int8/max' );
3232

3333
#### INT8_MAX
3434

35-
Maximum 8-bit signed integer.
35+
Maximum signed 8-bit integer.
3636

3737
```javascript
3838
var bool = ( INT8_MAX === 127 );

lib/node_modules/@stdlib/constants/uint16/num-bytes/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* Size (in bytes) of a 16-bit unsigned integer.
2323
*
2424
* @example
25-
* var bytes = UINT16_NUM_BYTES
25+
* var bytes = UINT16_NUM_BYTES;
2626
* // returns 2
2727
*/
2828
declare const UINT16_NUM_BYTES: number;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"constants",
5959
"const",
6060
"namespace",
61-
"int32",
61+
"uint32",
6262
"32-bit",
6363
"32bit",
6464
"integer",

lib/node_modules/@stdlib/datasets/afinn-96/test/test.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,12 @@ tape( 'main export is a function', function test( t ) {
4444
tape( 'the function returns an array of 2-element arrays', opts, function test( t ) {
4545
var list;
4646
var i;
47+
4748
list = afinn96();
48-
t.equal( isArray( list ), true, 'returns an array' );
49+
t.strictEqual( isArray( list ), true, 'returns an array' );
4950
for ( i = 0; i < list.length; i++ ) {
50-
t.equal( isArray( list[i] ), true, 'element '+i+' is an array' );
51-
t.equal( list[i].length, 2, 'element '+i+' is a 2-element array' );
51+
t.strictEqual( isArray( list[i] ), true, 'element '+i+' is an array' );
52+
t.strictEqual( list[i].length, 2, 'element '+i+' is a 2-element array' );
5253
}
5354
t.end();
5455
});
@@ -66,9 +67,9 @@ tape( 'the function returns a deep copy', opts, function test( t ) {
6667
v = d2[ 5 ][ 0 ];
6768
d1[ 5 ][ 0 ] = 'beep';
6869

69-
t.equal( d1[ 5 ][ 0 ], 'beep', 'expected element' );
70+
t.strictEqual( d1[ 5 ][ 0 ], 'beep', 'expected element' );
7071
t.notEqual( d1[ 5 ], d2[ 5 ], 'no shared state' );
71-
t.equal( d2[ 5 ][ 0 ], v, 'expected element' );
72+
t.strictEqual( d2[ 5 ][ 0 ], v, 'expected element' );
7273

7374
t.end();
7475
});

lib/node_modules/@stdlib/datasets/berndt-cps-wages-1985/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ var cps = require( '@stdlib/datasets/berndt-cps-wages-1985' );
3838

3939
#### cps()
4040

41-
Returns a random sample of 534 workers from the Current Population Survey (CPS) from 1985, including their wages and and other characteristics.
41+
Returns a random sample of 534 workers from the Current Population Survey (CPS) from 1985, including their wages and other characteristics.
4242

4343
```javascript
4444
var data = cps();

lib/node_modules/@stdlib/datasets/cdc-nchs-us-births-1969-1988/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,10 @@ Options:
166166

167167
- Data is written to `stdout` as comma-separated values ([CSV][csv]), where the first line is a header line.
168168

169+
</section>
170+
171+
<!-- /.notes -->
172+
169173
<section class="examples">
170174

171175
### Examples

lib/node_modules/@stdlib/datasets/cdc-nchs-us-births-1994-2003/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,10 @@ Options:
156156

157157
- Data is written to `stdout` as comma-separated values ([CSV][csv]), where the first line is a header line.
158158

159+
</section>
160+
161+
<!-- /.notes -->
162+
159163
<section class="examples">
160164

161165
### Examples

lib/node_modules/@stdlib/datasets/cdc-nchs-us-infant-mortality-bw-1915-2013/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,10 @@ Options:
109109

110110
- Data is written to `stdout` as comma-separated values ([CSV][csv]), where the first line is a header line.
111111

112+
</section>
113+
114+
<!-- /.notes -->
115+
112116
<section class="examples">
113117

114118
### Examples

lib/node_modules/@stdlib/datasets/cdc-nchs-us-infant-mortality-bw-1915-2013/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Returns
1212
-------
13-
out: Array<Object>
13+
out: Object
1414
Infant mortality data.
1515

1616
Examples

lib/node_modules/@stdlib/datasets/cdc-nchs-us-infant-mortality-bw-1915-2013/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var opts = {
4242
* - This function synchronously reads data from disk for each invocation. Such behavior is intentional and so is the avoidance of `require`. We assume that invocations are infrequent, and we want to avoid the `require` cache. This means that we allow data to be garbage collected and a user is responsible for explicitly caching data.
4343
*
4444
* @throws {Error} unable to read data
45-
* @returns {ObjectArray} infant mortality data
45+
* @returns {Object} infant mortality data
4646
*
4747
* @example
4848
* var data = dataset();

0 commit comments

Comments
 (0)