Skip to content

Commit 26dc3a2

Browse files
committed
docs: update docs and fix signature
--- 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: passed - 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 b798293 commit 26dc3a2

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

lib/node_modules/@stdlib/lapack/base/xerbla/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,11 @@ lapack_xerbla( "dlacpy", 1 )
116116
117117
The function accepts the following arguments:
118118
119-
- **name**: `[in] char*` name of routine.
120-
- **info**: `[in] LAPACK_INT` argument index.
119+
- **name**: `[in] char*` name of routine (e.g., `dlacpy`).
120+
- **info**: `[in] LAPACK_INT` error code (e.g., a negative argument index).
121121
122122
```c
123-
void lapack_xerbla( const char *name, const LAPACK_INT info );
123+
void lapack_xerbla( const char *name, LAPACK_INT info );
124124
```
125125

126126
</section>

lib/node_modules/@stdlib/lapack/base/xerbla/src/xerbla.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Prints an error message.
2525
*
2626
* @param name routine name (e.g., "dlacpy")
27-
* @param info argument index
27+
* @param info error code (e.g., a negative argument index)
2828
*/
2929
void API_SUFFIX(lapack_xerbla)( const char *name, LAPACK_INT info ) {
3030
if( info == LAPACK_WORK_MEMORY_ERROR ) {

lib/node_modules/@stdlib/lapack/base/xerbla/src/xerbla_lapacke.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* Prints an error message.
2424
*
2525
* @param name routine name (e.g., "dlacpy")
26-
* @param info argument index
26+
* @param info error code (e.g., a negative argument index)
2727
*/
2828
void API_SUFFIX(lapack_xerbla)( const char *name, LAPACK_INT info ) {
2929
API_SUFFIX(LAPACKE_xerbla)( name, info );

0 commit comments

Comments
 (0)