Skip to content

Commit b3817aa

Browse files
committed
docs: fix function signature and remove extrs spaces
--- 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent af7c8c4 commit b3817aa

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

lib/node_modules/@stdlib/blas/ext/base/dlinspace/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The function has the following parameters:
4848
- **N**: number of indexed elements.
4949
- **start**: start of interval.
5050
- **stop**: end of interval.
51-
- **endpoint**: boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
51+
- **endpoint**: boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
5252
- **x**: input [`Float64Array`][@stdlib/array/float64].
5353
- **strideX**: stride length.
5454

@@ -188,15 +188,17 @@ The function accepts the following arguments:
188188
- **N**: `[in] CBLAS_INT` number of indexed elements.
189189
- **start**: `[in] double` start of interval.
190190
- **stop**: `[in] double` end of interval.
191-
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
191+
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
192192
- **X**: `[out] double*` input array.
193193
- **strideX**: `[in] CBLAS_INT` stride length.
194194
195195
```c
196196
void stdlib_strided_dlinspace( const CBLAS_INT N, const double start, const double stop, const bool endpoint, double *X, const CBLAS_INT strideX );
197197
```
198198

199-
#### stdlib_strided_dlinspace_ndarray( N, start, \*X, strideX, offsetX )
199+
<!-- lint disable maximum-heading-length -->
200+
201+
#### stdlib_strided_dlinspace_ndarray( N, start, stop, endpoint, \*X, strideX, offsetX )
200202

201203
Fills a double-precision floating-point strided array with linearly spaced values over a specified interval using alternative indexing semantics.
202204

@@ -213,7 +215,7 @@ The function accepts the following arguments:
213215
- **N**: `[in] CBLAS_INT` number of indexed elements.
214216
- **start**: `[in] double` start of interval.
215217
- **stop**: `[in] double` end of interval.
216-
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
218+
- **endpoint**: `[in] bool` boolean indicating whether to include the `stop` value when writing values to the input array. If `true`, the input array is filled with evenly spaced values over the closed interval `[start, stop]`. If `false`, the input array is filled with evenly spaced values over the half-open interval `[start, stop)`.
217219
- **X**: `[out] double*` input array.
218220
- **strideX**: `[in] CBLAS_INT` stride length.
219221
- **offsetX**: `[in] CBLAS_INT` starting index.

lib/node_modules/@stdlib/blas/ext/base/slinspace/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,9 @@ The function accepts the following arguments:
196196
void stdlib_strided_slinspace( const CBLAS_INT N, const float start, const float stop, const bool endpoint, float *X, const CBLAS_INT strideX );
197197
```
198198

199-
#### stdlib_strided_slinspace_ndarray( N, start, \*X, strideX, offsetX )
199+
<!-- lint disable maximum-heading-length -->
200+
201+
#### stdlib_strided_slinspace_ndarray( N, start, stop, endpoint, \*X, strideX, offsetX )
200202

201203
Fills a single-precision floating-point strided array with linearly spaced values over a specified interval using alternative indexing semantics.
202204

0 commit comments

Comments
 (0)