Skip to content

Commit 239d0a4

Browse files
committed
build: fix templates to allow parameterization of dtype kind description
1 parent 25bbc26 commit 239d0a4

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

lib/node_modules/@stdlib/random/scripts/scaffolds/binary/data/README__md.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ var v = arr.get();
8282

8383
The function accepts the following options:
8484

85-
- **dtype**: output ndarray data type. Must be a {{README_DTYPE_KIND_DESC}} or "generic" [data type][@stdlib/ndarray/dtypes].
85+
- **dtype**: output ndarray data type. Must be {{README_DTYPE_KIND_DESC}} or "generic" [data type][@stdlib/ndarray/dtypes].
8686
- **order**: ndarray order (i.e., memory layout), which is either `row-major` (C-style) or `column-major` (Fortran-style). Default: `'row-major'`.
8787
- **mode**: specifies how to handle indices which exceed ndarray dimensions. For a list of supported modes, see [`ndarray`][@stdlib/ndarray/ctor]. Default: `'throw'`.
8888
- **submode**: a mode array which specifies for each dimension how to handle subscripts which exceed ndarray dimensions. If provided fewer modes than dimensions, an [ndarray][@stdlib/ndarray/ctor] instance recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
@@ -307,7 +307,7 @@ var sz = random.byteLength;
307307

308308
- If PRNG state is "shared" (meaning a state array was provided during function creation and **not** copied) and one sets the underlying generator state to a state array having a different length, the function returned by the `factory` method does **not** update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for **each** relevant creation function and/or PRNG must be **explicitly** set.
309309
- If PRNG state is "shared" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).
310-
- The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, the function must return an [ndarray][@stdlib/ndarray/ctor] having a real-valued floating-point or "generic" [data type][@stdlib/ndarray/dtypes]. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].
310+
- The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, the function must return an [ndarray][@stdlib/ndarray/ctor] having {{README_DTYPE_KIND_DESC}} or "generic" [data type][@stdlib/ndarray/dtypes]. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].
311311

312312
</section>
313313

lib/node_modules/@stdlib/random/scripts/scaffolds/binary/data/docs/repl__txt.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@
1717
Options.
1818

1919
options.dtype: string (optional)
20-
Array data type. Must be a real-valued floating-point or "generic" data
21-
type.
20+
{{REPL_TEXT_DTYPE_DESC}}
2221

2322
options.order: string (optional)
2423
Specifies whether an array is row-major (C-style) or column-major

0 commit comments

Comments
 (0)