Skip to content

docs: fix examples and notes - #16144

Merged
kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-10-14
Oct 14, 2026
Merged

kgryte merged 3 commits into
developfrom
philipp/fix-commit-review-2026-10-14

Conversation

@Planeshifter

@Planeshifter Planeshifter commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Follow-up fixes for commits merged to develop between 2026-10-13 15:26 UTC (abeb4a5) and 2026-10-14 12:12 UTC (5dbad73).

This pull request:

  • array/uint64: Remove unused var Uint64 = require( '@stdlib/number/uint64/ctor' ); from the entries() example in array/uint64 (README.md and lib/main.js), left dead after acc3ee3 switched the example to new Uint64Array( [ 1, 2, 3 ] ).
  • blas/ext/base/ndarray/gediff: Fix prepend/append docs in blas/ext/base/ndarray/gediff/README.md (introduced in 0eb422d): the values are added to the output after computing differences, not "prior to", consistent with the implementation, the README example output ([1,2,2,2,2,11]), and the strided blas/ext/base/gediff docs.

Related Issues

Does this pull request have any related issues?

None.

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 33 first-parent commits to develop in the window (fixtures, generated SVGs, and REPL data excluded).
  • Checked style-guide compliance against reference sibling packages (e.g., dsum, zone-to, dediff, dcartesian-power, is-equal-int32array) and scanned for bugs in the C implementations (*wx*y, cone-to), the new packages, the namespace updates, the cosqi change, and the ULP test migrations.
  • Deliberately excluded anything requiring interpretation (cosmetic blank lines, README comment style) and anything predating the window. In particular, ndarray/dediff README has the same "prior to computing differences" wording, and the set() example in the array/uint64 README has an unused Uint64 require, but both predate this window and are left untouched.
  • The same dead Uint64 require also exists in the entries() example in array/uint64/docs/types/index.d.ts. That file is intentionally left untouched here: any change to it trips pre-existing @typescript-eslint/no-unused-vars errors (unused Iterator, LocaleOptions, Predicate, Callback, MapFcn, Reducer, CompareFcn aliases, introduced in 1976459) that are out of scope for this PR.

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.


🤖 Generated with Claude Code

https://claude.ai/code/session_01STtNJiPDdWda8FSycme2x7

Drop the declaration-file change, as touching the file surfaces pre-existing `no-unused-vars` lint errors unrelated to this fix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01STtNJiPDdWda8FSycme2x7
@stdlib-bot

stdlib-bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
array/uint64 $\\color{red}1316/1321$
$\\color{green}+99.62\\%$
$\\color{red}196/200$
$\\color{green}+98.00\\%$
$\\color{green}21/21$
$\\color{green}+100.00\\%$
$\\color{red}1316/1321$
$\\color{green}+99.62\\%$
blas/ext/base/ndarray/gediff $\\color{green}160/160$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}160/160$
$\\color{green}+100.00\\%$

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

@kgryte
kgryte marked this pull request as ready for review October 14, 2026 18:35
@kgryte
kgryte requested a review from a team October 14, 2026 18:35
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Oct 14, 2026
@kgryte kgryte changed the title docs: fix issues in recently merged commits docs: fix examples and notes Oct 14, 2026
@kgryte
kgryte merged commit a800ae0 into develop Oct 14, 2026
35 checks passed
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Oct 14, 2026
@kgryte
kgryte deleted the philipp/fix-commit-review-2026-10-14 branch October 14, 2026 18:38
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Oct 14, 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