Skip to content

Commit 038e74d

Browse files
committed
docs: revert back to using 'constructor' instead of 'function'
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - 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: passed - task: lint_license_headers status: passed ---
1 parent c216219 commit 038e74d

File tree

6 files changed

+10
-10
lines changed
  • lib/node_modules/@stdlib/stats/base/ztest

6 files changed

+10
-10
lines changed

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/factory/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ import resultsFactory = require( './index' );
5353
const r3 = new Results( new ArrayBuffer( 80 ), 8, 16 ); // $ExpectType ResultsStruct<Float64Array>
5454
}
5555

56-
// The returned function can be invoked without `new`...
56+
// The returned constructor can be invoked without `new`...
5757
{
5858
const Results = resultsFactory( 'float64' );
5959

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float32/docs/types/test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import Results = require( './index' );
2121

2222
// TESTS //
2323

24-
// The function returns a results object...
24+
// The constructor returns a results object...
2525
{
2626
// eslint-disable-next-line @typescript-eslint/no-unused-vars
2727
const r0 = new Results( {} ); // $ExpectType ResultsStruct
@@ -36,7 +36,7 @@ import Results = require( './index' );
3636
const r3 = new Results( new ArrayBuffer( 80 ), 8, 16 ); // $ExpectType ResultsStruct
3737
}
3838

39-
// The function can be invoked without `new`...
39+
// The constructor can be invoked without `new`...
4040
{
4141
// eslint-disable-next-line @typescript-eslint/no-unused-vars
4242
const r0 = Results( {} ); // $ExpectType ResultsStruct

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float64/docs/types/test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import Results = require( './index' );
2121

2222
// TESTS //
2323

24-
// The function returns a results object...
24+
// The constructor returns a results object...
2525
{
2626
// eslint-disable-next-line @typescript-eslint/no-unused-vars
2727
const r0 = new Results( {} ); // $ExpectType ResultsStruct
@@ -36,7 +36,7 @@ import Results = require( './index' );
3636
const r3 = new Results( new ArrayBuffer( 80 ), 8, 16 ); // $ExpectType ResultsStruct
3737
}
3838

39-
// The function can be invoked without `new`...
39+
// The constructor can be invoked without `new`...
4040
{
4141
// eslint-disable-next-line @typescript-eslint/no-unused-vars
4242
const r0 = Results( {} ); // $ExpectType ResultsStruct

lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/factory/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ import resultsFactory = require( './index' );
5353
const r3 = new Results( new ArrayBuffer( 80 ), 8, 16 ); // $ExpectType ResultsStruct<Float64Array>
5454
}
5555

56-
// The returned function can be invoked without `new`...
56+
// The returned constructor can be invoked without `new`...
5757
{
5858
const Results = resultsFactory( 'float64' );
5959

lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float32/docs/types/test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import Results = require( './index' );
2121

2222
// TESTS //
2323

24-
// The function returns a results object...
24+
// The constructor returns a results object...
2525
{
2626
// eslint-disable-next-line @typescript-eslint/no-unused-vars
2727
const r0 = new Results( {} ); // $ExpectType ResultsStruct
@@ -36,7 +36,7 @@ import Results = require( './index' );
3636
const r3 = new Results( new ArrayBuffer( 80 ), 8, 16 ); // $ExpectType ResultsStruct
3737
}
3838

39-
// The function can be invoked without `new`...
39+
// The constructor can be invoked without `new`...
4040
{
4141
// eslint-disable-next-line @typescript-eslint/no-unused-vars
4242
const r0 = Results( {} ); // $ExpectType ResultsStruct

lib/node_modules/@stdlib/stats/base/ztest/two-sample/results/float64/docs/types/test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import Results = require( './index' );
2121

2222
// TESTS //
2323

24-
// The function returns a results object...
24+
// The constructor returns a results object...
2525
{
2626
// eslint-disable-next-line @typescript-eslint/no-unused-vars
2727
const r0 = new Results( {} ); // $ExpectType ResultsStruct
@@ -36,7 +36,7 @@ import Results = require( './index' );
3636
const r3 = new Results( new ArrayBuffer( 80 ), 8, 16 ); // $ExpectType ResultsStruct
3737
}
3838

39-
// The function can be invoked without `new`...
39+
// The constructor can be invoked without `new`...
4040
{
4141
// eslint-disable-next-line @typescript-eslint/no-unused-vars
4242
const r0 = Results( {} ); // $ExpectType ResultsStruct

0 commit comments

Comments
 (0)