Skip to content

Commit de2ad7d

Browse files
committed
docs: add JSDoc tags
--- 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: passed - 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: na - task: lint_license_headers status: passed ---
1 parent 9344423 commit de2ad7d

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

lib/node_modules/@stdlib/math/base/special/bessely1/docs/types/index.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,23 @@
3232
* var v = y1( 0.0 );
3333
* // returns -Infinity
3434
*
35+
* @example
3536
* v = y1( 1.0 );
3637
* // returns ~-0.781
3738
*
39+
* @example
3840
* v = y1( -1.0 );
3941
* // returns NaN
4042
*
43+
* @example
4144
* v = y1( Infinity );
4245
* // returns 0.0
4346
*
47+
* @example
4448
* v = y1( -Infinity );
4549
* // returns NaN
4650
*
51+
* @example
4752
* v = y1( NaN );
4853
* // returns NaN
4954
*/

lib/node_modules/@stdlib/math/base/special/bessely1/lib/main.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,18 +79,23 @@ var sc = [ 0.0, 0.0 ];
7979
* var v = y1( 0.0 );
8080
* // returns -Infinity
8181
*
82+
* @example
8283
* v = y1( 1.0 );
8384
* // returns ~-0.781
8485
*
86+
* @example
8587
* v = y1( -1.0 );
8688
* // returns NaN
8789
*
90+
* @example
8891
* v = y1( Infinity );
8992
* // returns 0.0
9093
*
94+
* @example
9195
* v = y1( -Infinity );
9296
* // returns NaN
9397
*
98+
* @example
9499
* v = y1( NaN );
95100
* // returns NaN
96101
*/

lib/node_modules/@stdlib/math/base/special/bessely1/lib/native.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,23 @@ var addon = require( './../src/addon.node' );
3737
* var v = y1( 0.0 );
3838
* // returns -Infinity
3939
*
40+
* @example
4041
* v = y1( 1.0 );
4142
* // returns ~-0.781
4243
*
44+
* @example
4345
* v = y1( -1.0 );
4446
* // returns NaN
4547
*
48+
* @example
4649
* v = y1( Infinity );
4750
* // returns 0.0
4851
*
52+
* @example
4953
* v = y1( -Infinity );
5054
* // returns NaN
5155
*
56+
* @example
5257
* v = y1( NaN );
5358
* // returns NaN
5459
*/

0 commit comments

Comments
 (0)