docs: fix TSDoc return annotation

Planeshifter · Planeshifter · commit bf3b1ce6e981 · 2025-12-04T23:24:42.000-06:00
---
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: na
  - 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: passed
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/ndarray/broadcast-arrays/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/broadcast-arrays/docs/types/index.d.ts
@@ -53,7 +53,7 @@ import { typedndarray } from '@stdlib/types/ndarray';
 * // returns [ 3, 2, 2 ]
 *
 * var out = broadcastArrays( [ x1, y1 ] );
-* // returns <ndarray>
+* // returns [ <ndarray>, <ndarray> ]
 *
 * var x2 = out[ 0 ];
 * // returns <ndarray>
@@ -129,7 +129,7 @@ declare function broadcastArrays<T = unknown>( arrays: ArrayLike<typedndarray<T>
 * // returns [ 3, 2, 2 ]
 *
 * var out = broadcastArrays( [ x1, y1 ] );
-* // returns <ndarray>
+* // returns [ <ndarray>, <ndarray> ]
 *
 * var x2 = out[ 0 ];
 * // returns <ndarray>

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ import { typedndarray } from '@stdlib/types/ndarray';`
`53`	`53`	`* // returns [ 3, 2, 2 ]`
`54`	`54`	`*`
`55`	`55`	`* var out = broadcastArrays( [ x1, y1 ] );`
`56`		`-* // returns <ndarray>`
	`56`	`+* // returns [ <ndarray>, <ndarray> ]`
`57`	`57`	`*`
`58`	`58`	`* var x2 = out[ 0 ];`
`59`	`59`	`* // returns <ndarray>`
`@@ -129,7 +129,7 @@ declare function broadcastArrays<T = unknown>( arrays: ArrayLike<typedndarray<T>`
`129`	`129`	`* // returns [ 3, 2, 2 ]`
`130`	`130`	`*`
`131`	`131`	`* var out = broadcastArrays( [ x1, y1 ] );`
`132`		`-* // returns <ndarray>`
	`132`	`+* // returns [ <ndarray>, <ndarray> ]`
`133`	`133`	`*`
`134`	`134`	`* var x2 = out[ 0 ];`
`135`	`135`	`* // returns <ndarray>`