Skip to content

Commit 715ab2e

Browse files
committed
docs: update function description
--- 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: na - 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: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - 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 669f20c commit 715ab2e

File tree

8 files changed

+11
-11
lines changed

8 files changed

+11
-11
lines changed

lib/node_modules/@stdlib/math/base/special/round-nearest-even/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# roundNearestEven
2222

23-
> Round a numeric value to the nearest integer with ties rounding to the nearest even integer.
23+
> Round a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var roundNearestEven = require( '@stdlib/math/base/special/round-nearest-even' )
3232

3333
#### roundNearestEven( x )
3434

35-
Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer.
35+
Rounds a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
3636

3737
```javascript
3838
var v = roundNearestEven( -3.5 );
@@ -136,7 +136,7 @@ logEachMap( 'roundNearestEven(%.4f) = %.4f', x, roundNearestEven );
136136

137137
#### stdlib_base_round_nearest_even( x )
138138

139-
Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer.
139+
Rounds a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
140140

141141
```c
142142
double out = stdlib_base_round_nearest_even( -4.5 );

lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/repl.txt

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

22
{{alias}}( x )
3-
Rounds a numeric value to the nearest integer with ties rounding to the
4-
nearest even integer.
3+
Rounds a double-precision floating-point number to the nearest integer value
4+
with ties rounding to the nearest even integer.
55

66
Parameters
77
----------

lib/node_modules/@stdlib/math/base/special/round-nearest-even/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer.
22+
* Rounds a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
2323
*
2424
* @param x - input value
2525
* @returns function value

lib/node_modules/@stdlib/math/base/special/round-nearest-even/include/stdlib/math/base/special/round_nearest_even.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer.
30+
* Rounds a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
3131
*/
3232
double stdlib_base_round_nearest_even( const double x );
3333

lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Round a numeric value to the nearest integer with ties rounding to the nearest even integer.
22+
* Round a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
2323
*
2424
* @module @stdlib/math/base/special/round-nearest-even
2525
*

lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ var floor = require( '@stdlib/math/base/special/floor' );
2828
// MAIN //
2929

3030
/**
31-
* Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer.
31+
* Rounds a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
3232
*
3333
* @param {number} x - input value
3434
* @returns {number} function value

lib/node_modules/@stdlib/math/base/special/round-nearest-even/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer.
29+
* Rounds a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
3030
*
3131
* @private
3232
* @param {number} x - input value

lib/node_modules/@stdlib/math/base/special/round-nearest-even/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
#include <stdint.h>
2525

2626
/**
27-
* Rounds a numeric value to the nearest integer with ties rounding to the nearest even integer.
27+
* Rounds a double-precision floating-point number to the nearest integer value with ties rounding to the nearest even integer.
2828
*
2929
* @param x input value
3030
* @return output value

0 commit comments

Comments
 (0)