Skip to content

Commit bef362e

Browse files
committed
docs: update phrasing in wrap 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: 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent d3e9457 commit bef362e

File tree

9 files changed

+11
-11
lines changed

9 files changed

+11
-11
lines changed

lib/node_modules/@stdlib/math/base/special/wrap/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
# wrap
2222

23-
> Wrap a value on the half-open interval `[min,max)`.
23+
> Wrap a value to the half-open interval `[min,max)`.
2424
2525
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

@@ -42,7 +42,7 @@ var wrap = require( '@stdlib/math/base/special/wrap' );
4242

4343
#### wrap( v, min, max )
4444

45-
Wraps a value on the half-open interval `[min,max)`.
45+
Wraps a value to the half-open interval `[min,max)`.
4646

4747
```javascript
4848
var v = wrap( 3.14, 0.0, 5.0 );
@@ -152,7 +152,7 @@ logEachMap( 'wrap(%d,%d,%d) => %0.4f', v, min, max, wrap );
152152

153153
#### stdlib_base_wrap( v, min, max )
154154

155-
Wraps a value on the half-open interval `[min,max)`.
155+
Wraps a value to the half-open interval `[min,max)`.
156156

157157
```c
158158
double v = stdlib_base_wrap( 3.14, 0.0, 5.0 );

lib/node_modules/@stdlib/math/base/special/wrap/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( v, min, max )
3-
Wraps a value on the half-open interval `[min,max)`.
3+
Wraps a value to the half-open interval `[min,max)`.
44

55
The function does not distinguish between positive and negative zero. Where
66
appropriate, the function returns positive zero.

lib/node_modules/@stdlib/math/base/special/wrap/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-
* Wraps a value on the half-open interval `[min,max)`.
22+
* Wraps a value to the half-open interval `[min,max)`.
2323
*
2424
* @param v - input value
2525
* @param min - minimum value

lib/node_modules/@stdlib/math/base/special/wrap/include/stdlib/math/base/special/wrap.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-
* Wraps a value on the half-open interval [min,max).
30+
* Wraps a value to the half-open interval [min,max).
3131
*/
3232
double stdlib_base_wrap( const double v, const double min, const double max );
3333

lib/node_modules/@stdlib/math/base/special/wrap/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-
* Wrap a value on the half-open interval `[min,max)`.
22+
* Wrap a value to the half-open interval `[min,max)`.
2323
*
2424
* @module @stdlib/math/base/special/wrap
2525
*

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

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

2929
/**
30-
* Wraps a value on the half-open interval `[min,max)`.
30+
* Wraps a value to the half-open interval `[min,max)`.
3131
*
3232
* @param {number} v - input value
3333
* @param {number} min - minimum value

lib/node_modules/@stdlib/math/base/special/wrap/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-
* Wraps a value on the half-open interval `[min,max)`.
29+
* Wraps a value to the half-open interval `[min,max)`.
3030
*
3131
* @private
3232
* @param {number} v - input value

lib/node_modules/@stdlib/math/base/special/wrap/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/math/base/special/wrap",
33
"version": "0.0.0",
4-
"description": "Wrap a value on the half-open interval [min,max).",
4+
"description": "Wrap a value to the half-open interval [min,max).",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

lib/node_modules/@stdlib/math/base/special/wrap/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
#include "stdlib/math/base/assert/is_negative_zero.h"
2424

2525
/**
26-
* Wraps a value on the half-open interval [min,max).
26+
* Wraps a value to the half-open interval [min,max).
2727
*
2828
* @param v input value
2929
* @param min minimum value

0 commit comments

Comments
 (0)