Skip to content

Commit 7d56c67

Browse files
committed
docs: revert the changes in JSDoc
--- 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent fdac84b commit 7d56c67

File tree

4 files changed

+32
-24
lines changed

4 files changed

+32
-24
lines changed

lib/node_modules/@stdlib/math/base/special/ellipj/lib/am.js

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,23 @@ var tmp = [ 0.0, 0.0, 0.0, 0.0 ];
3838
* @returns {number} Jacobi amplitude, `am`
3939
*
4040
* @example
41-
* var am = require( '@stdlib/math/base/special/ellipj' ).am;
42-
*
4341
* var v = am( 0.3, 0.5 );
4442
* // returns ~0.298
4543
*
46-
* v = am( 0.0, 0.0 );
44+
* @example
45+
* var v = am( 0.0, 0.0 );
4746
* // returns ~0.0
4847
*
49-
* v = am( Infinity, 1.0 );
48+
* @example
49+
* var v = am( Infinity, 1.0 );
5050
* // returns ~1.571
5151
*
52-
* v = am( 0.0, -2.0 );
52+
* @example
53+
* var v = am( 0.0, -2.0 );
5354
* // returns NaN
5455
*
55-
* v = am( NaN, NaN );
56+
* @example
57+
* var v = am( NaN, NaN );
5658
* // returns NaN
5759
*/
5860
function am( u, m ) {

lib/node_modules/@stdlib/math/base/special/ellipj/lib/cn.js

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,23 @@ var tmp = [ 0.0, 0.0, 0.0, 0.0 ];
3838
* @returns {number} cn(u, m)
3939
*
4040
* @example
41-
* var cn = require( '@stdlib/math/base/special/ellipj' ).cn;
42-
*
4341
* var v = cn( 0.3, 0.5 );
4442
* // returns ~0.956
4543
*
46-
* v = cn( 0.0, 0.0 );
44+
* @example
45+
* var v = cn( 0.0, 0.0 );
4746
* // returns ~1.0
4847
*
49-
* v = cn( Infinity, 1.0 );
48+
* @example
49+
* var v = cn( Infinity, 1.0 );
5050
* // returns ~0.0
5151
*
52-
* v = cn( 0.0, -2.0 );
52+
* @example
53+
* var v = cn( 0.0, -2.0 );
5354
* // returns ~1.0
5455
*
55-
* v = cn( NaN, NaN );
56+
* @example
57+
* var v = cn( NaN, NaN );
5658
* // returns NaN
5759
*/
5860
function cn( u, m ) {

lib/node_modules/@stdlib/math/base/special/ellipj/lib/dn.js

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,23 @@ var tmp = [ 0.0, 0.0, 0.0, 0.0 ];
3838
* @returns {number} dn(u, m)
3939
*
4040
* @example
41-
* var dn = require( '@stdlib/math/base/special/ellipj' ).dn;
42-
*
4341
* var v = dn( 0.3, 0.5 );
4442
* // returns ~0.978
4543
*
46-
* v = dn( 0.0, 0.0 );
44+
* @example
45+
* var v = dn( 0.0, 0.0 );
4746
* // returns ~1.0
4847
*
49-
* v = dn( Infinity, 1.0 );
48+
* @example
49+
* var v = dn( Infinity, 1.0 );
5050
* // returns ~0.0
5151
*
52-
* v = dn( 0.0, -2.0 );
52+
* @example
53+
* var v = dn( 0.0, -2.0 );
5354
* // returns ~1.0
5455
*
55-
* v = dn( NaN, NaN );
56+
* @example
57+
* var v = dn( NaN, NaN );
5658
* // returns NaN
5759
*/
5860
function dn( u, m ) {

lib/node_modules/@stdlib/math/base/special/ellipj/lib/sn.js

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,23 @@ var tmp = [ 0.0, 0.0, 0.0, 0.0 ];
3838
* @returns {number} sn(u, m)
3939
*
4040
* @example
41-
* var sn = require( '@stdlib/math/base/special/ellipj' ).sn;
42-
*
4341
* var v = sn( 0.3, 0.5 );
4442
* // returns ~0.293
4543
*
46-
* v = sn( 0.0, 0.0 );
44+
* @example
45+
* var v = sn( 0.0, 0.0 );
4746
* // returns ~0.0
4847
*
49-
* v = sn( Infinity, 1.0 );
48+
* @example
49+
* var v = sn( Infinity, 1.0 );
5050
* // returns ~1.0
5151
*
52-
* v = sn( 0.0, -2.0 );
52+
* @example
53+
* var v = sn( 0.0, -2.0 );
5354
* // returns ~0.0
5455
*
55-
* v = sn( NaN, NaN );
56+
* @example
57+
* var v = sn( NaN, NaN );
5658
* // returns NaN
5759
*/
5860
function sn( u, m ) {

0 commit comments

Comments
 (0)