Skip to content

Commit 66f9e29

Browse files
committed
docs: fix 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: passed - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 24e1741 commit 66f9e29

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

lib/node_modules/@stdlib/blas/ext/linspace/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The function has the following parameters:
5555
The function accepts the following options:
5656

5757
- **dims**: list of dimensions over which to perform operation. If not provided, the function generates linearly spaced values along the last dimension. Default: `[-1]`.
58-
- **dtype**: output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes]. If both `start` and `stop` are real-valued, the output array data type may be any floating-point data type or "generic". However, if either `start` or `stop` are complex-valued, the output array type must be a complex floating-point data type or "generic". If a data type is provided, `start` and `stop` are cast to the specified data type. If a data type is not provided and both `start` and `stop` are the same type (either `'float64'`, `'complex64'`, or `'complex128'`), the default output array data type is the same type as the input values (either `'float64'`, `'complex64'`, or `'complex128'`, respectively). Otherwise, if not provided, the default output array data type is `'complex128'`.
58+
- **dtype**: output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes]. If both `start` and `stop` are real-valued, the output array data type may be any floating-point data type or "generic". However, if either `start` or `stop` are complex-valued, the output array type must be a complex floating-point data type or "generic". If a data type is provided, `start` and `stop` are cast to the specified data type. If a data type is not provided and both `start` and `stop` are the same type (either `'float64'`, `'complex64'`, or `'complex128'`), the default output array data type is the same type as the input values (either `'float64'`, `'complex64'`, or `'complex128'`, respectively). Otherwise, if a data type is not provided and `start` and `stop` have different types, the default output array data type is determined according to type promotion rules.
5959
- **order**: specifies whether an [ndarray][@stdlib/ndarray/ctor] is `'row-major'` (C-style) or `'column-major'` (Fortran-style). If `start`, `stop`, and `endpoint` are scalar values, the default order is `'row-major'`. If `start`, `stop`, and/or `endpoint` arrays have the same memory layout, the default order is the same layout. Otherwise, the default order is `'row-major'`.
6060
- **mode**: specifies how to handle indices which exceed array dimensions (see [`ndarray`][@stdlib/ndarray/ctor]). Default: `'throw'`.
6161
- **submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions (see [`ndarray`][@stdlib/ndarray/ctor]). If provided fewer modes than dimensions, the constructor recycles modes using modulo arithmetic. Default: `[ options.mode ]`.

lib/node_modules/@stdlib/blas/ext/linspace/docs/repl.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,9 @@
8787
provided and both `start` and `stop` are the same type (either
8888
'float64', 'complex64', or 'complex128'), the default output array data
8989
type is the same type as the input values (either 'float64',
90-
'complex64', or 'complex128', respectively). Otherwise, if not provided,
91-
the default output array data type is 'complex128'.
90+
'complex64', or 'complex128', respectively). Otherwise, if a data type
91+
is not provided and `start` and `stop` have different types, the default
92+
output array data type is determined according to type promotion rules.
9293

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

0 commit comments

Comments
 (0)