Skip to content

Commit 9cd5e7a

Browse files
committed
Auto-generated commit
1 parent 93a2213 commit 9cd5e7a

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232

3333
<details>
3434

35+
- [`7475400`](https://github.com/stdlib-js/stdlib/commit/7475400f3b912be86c17f2a915d1a4febcc6522d) - **docs:** move content to notes _(by Athan Reines)_
3536
- [`16ce439`](https://github.com/stdlib-js/stdlib/commit/16ce439eb07c2a3212008ed9d2f5f6848da200f1) - **refactor:** update examples and return the input ndarray _(by Athan Reines)_
3637
- [`11e6c60`](https://github.com/stdlib-js/stdlib/commit/11e6c608e47109a8576613435dc1c43ea2d9dbc8) - **bench:** fix typo in filename _(by Athan Reines)_
3738
- [`8aad405`](https://github.com/stdlib-js/stdlib/commit/8aad4050220ad7cff7b807f0913dcab3d8555fae) - **docs:** add markup _(by Athan Reines)_

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,6 @@ The function accepts the following arguments:
9393
- **x**: input ndarray.
9494
- **value**: scalar value.
9595

96-
A provided ndarray should be an object with the following properties:
97-
98-
- **dtype**: data type.
99-
- **data**: data buffer.
100-
- **shape**: dimensions.
101-
- **strides**: stride lengths.
102-
- **offset**: index offset.
103-
- **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
104-
10596
</section>
10697

10798
<!-- /.usage -->
@@ -110,8 +101,19 @@ A provided ndarray should be an object with the following properties:
110101

111102
## Notes
112103

104+
- A provided ndarray should be an object with the following properties:
105+
106+
- **dtype**: data type.
107+
- **data**: data buffer.
108+
- **shape**: dimensions.
109+
- **strides**: stride lengths.
110+
- **offset**: index offset.
111+
- **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
112+
113113
- If `value` is a number and `x` has a complex [data type][@stdlib/ndarray/dtypes], the function fills an input ndarray with a complex number whose real component equals the provided scalar `value` and whose imaginary component is zero.
114+
114115
- A `value` must be able to safely cast to the input ndarray [data type][@stdlib/ndarray/dtypes]. Scalar values having floating-point data types (both real and complex) are allowed to downcast to a lower precision data type of the same kind (e.g., a scalar double-precision floating-point number can be used to fill a `'float32'` input ndarray).
116+
115117
- The function **mutates** the input ndarray.
116118

117119
</section>

0 commit comments

Comments
 (0)