Skip to content

docs: remove non-applicable buffer parameters - #16489

Merged
kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-11-04
Nov 6, 2026
Merged

kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-11-04

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

Follow-up fixes for commits merged to develop between 2026-11-03T22:34:19Z (b2c3ac9) and 2026-11-04T10:21:21Z (2693b6b).

ndarray/vector/generic

  • Removes copy-pasted @param entries from the ctor JSDoc in ndarray/vector/generic/docs/types/index.d.ts. They came in with d7bef11 from ndarray/vector/float64. The arg description no longer mentions "buffer", and the byteOffset and length params are removed: GenericVector throws on ArrayBuffer input and accepts neither.

ndarray/vector

  • Fixes the stale GenericVector JSDoc in ndarray/vector/docs/types/index.d.ts, which dc28a63 (the auto-generated namespace declaration update) copied from the outdated package docs. Drops "buffer" from the arg description and removes the byteOffset and length params, matching ndarray/vector/generic. GenericVector throws on an ArrayBuffer.

Related Issues

Does this pull request have any related issues?

None.

Reference Packages

Did the content of this pull request follow one or more existing packages? Answering is optional.

This pull request followed these packages:

  • ndarray/vector/generic (its lib/main.js JSDoc and GenericVector interface overloads)

What carried over from the reference(s)?

  • The @param arg description from ndarray/vector/generic/lib/main.js.

What differed, or what did you have to work out yourself?

  • Nothing.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Validation

  • Reviewed 26 commits merged to develop in the window. Two independent passes checked compliance with docs/style-guides against reference packages. Two independent passes scanned the diff for bugs. Three of the four flagged this issue independently.
  • I re-checked the fix against ndarray/vector/generic/lib/main.js (it throws a TypeError on ArrayBuffer), test/test.js, and the interface overloads.
  • Excluded: auto-generated commits (REPL data, equation SVGs, trailing-newline normalization in repl.txt), and anything that needs interpretation or changes outside the diff window. For example, _tools/pkgs/entry-points/lib/sync.js still has the callback @throws tag that 7f74397 removed from its siblings, but that file is not in the window.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was written primarily by Claude Code as part of an automated daily review of commits merged to develop.


@stdlib-js/reviewers


Generated by Claude Code

@stdlib-bot

stdlib-bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ndarray/vector $\\color{red}3451/3813$
$\\color{green}+0.00\\%$
$\\color{red}32/34$
$\\color{green}+0.00\\%$
$\\color{red}1/7$
$\\color{green}+0.00\\%$
$\\color{red}3451/3813$
$\\color{green}+0.00\\%$
ndarray/vector/generic $\\color{green}156/156$
$\\color{green}+0.00\\%$
$\\color{green}9/9$
$\\color{green}+0.00\\%$
$\\color{green}1/1$
$\\color{green}+0.00\\%$
$\\color{green}156/156$
$\\color{green}+0.00\\%$

The above coverage report was generated for the changes in this PR.

@kgryte
kgryte marked this pull request as ready for review November 5, 2026 23:33
@kgryte
kgryte requested a review from a team November 5, 2026 23:33
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Nov 5, 2026
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Nov 5, 2026

Copy link
Copy Markdown
Member Author

The Run affected tests failure on 6d11bb2 (run) does not come from this PR.

  • That run was triggered by the push of the develop merge commit. It tested every package the merge pulled in, and the job hit the workflow's 30-minute timeout. Along the way, blas/ext/circshift/test/test.js (L248, L278) reported broadcast-compatibility t.throws failures. This PR does not touch that package.
  • The same push workflow also timed out on the base commit 7349dff (run). The pull_request-triggered Run affected tests run on this head passed.
  • This PR changes only two .d.ts JSDoc blocks. I have no fix to port. The circshift failures and the timeout need to be fixed on develop.

Generated by Claude Code

@kgryte

kgryte commented Nov 6, 2026

Copy link
Copy Markdown
Member

As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge.

@kgryte kgryte changed the title docs: remove non-applicable buffer parameters from GenericVector declarations docs: remove non-applicable buffer parameters Nov 6, 2026
@kgryte
kgryte merged commit 9b0a318 into develop Nov 6, 2026
46 of 48 checks passed
@kgryte
kgryte deleted the philipp/fix-commit-review-2026-11-04 branch November 6, 2026 00:13
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Nov 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants