Skip to content

Commit 57bd4e5

Browse files
committed
docs: update descriptions
--- 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: 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 c2ec1c9 commit 57bd4e5

File tree

1 file changed

+5
-5
lines changed
  • lib/node_modules/@stdlib/ndarray/with

1 file changed

+5
-5
lines changed

lib/node_modules/@stdlib/ndarray/with/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ limitations under the License.
1818
1919
-->
2020

21-
# with
21+
# ndarrayWith
2222

23-
> Return an [ndarray][@stdlib/ndarray/ctor] with element at specified indices replaced by a provided value.
23+
> Return a new [ndarray][@stdlib/ndarray/ctor] with the element at a specified index replaced by a provided value.
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

@@ -40,9 +40,9 @@ limitations under the License.
4040
var ndarrayWith = require( '@stdlib/ndarray/with' );
4141
```
4242

43-
#### with( x, indices, value )
43+
#### ndarrayWith( x, indices, value )
4444

45-
Returns an [ndarray][@stdlib/ndarray/ctor] with element at specified indices replaced by a provided value.
45+
Returns a new [ndarray][@stdlib/ndarray/ctor] with the element at a specified index replaced by a provided value.
4646

4747
```javascript
4848
var zeros = require( '@stdlib/ndarray/zeros' );
@@ -69,7 +69,7 @@ var v = out.get( 0, 0 );
6969

7070
## Notes
7171

72-
- This function doesnot validate that a provided `value` is compatible with the data type of the input [ndarray][@stdlib/ndarray/ctor]. For example, the function doesnot guard against precision loss when `value` is a real-valued number and the input [ndarray][@stdlib/ndarray/ctor] has an integer data type. This function should be considered a copy-on-write analog to using an [ndarray][@stdlib/ndarray/ctor] `set` method. Whether a `value` is silently coerced to the data type of the input [ndarray][@stdlib/ndarray/ctor] or triggers an exception when incompatible is implementation-dependent. Accordingly, any assertion logic ensuring data type compatibility should be performed **before** calling this function.
72+
- This function does not validate that a provided `value` is compatible with the data type of the input [ndarray][@stdlib/ndarray/ctor]. For example, the function does not guard against precision loss when `value` is a real-valued number and the input [ndarray][@stdlib/ndarray/ctor] has an integer data type. This function should be considered a copy-on-write analog to using an [ndarray][@stdlib/ndarray/ctor]'s `set` method. Whether a `value` is silently coerced to the data type of the input [ndarray][@stdlib/ndarray/ctor] or triggers an exception when incompatible is implementation-dependent. Accordingly, any assertion logic ensuring data type compatibility should be performed **before** calling this function.
7373

7474
</section>
7575

0 commit comments

Comments
 (0)