Skip to content

docs: add backticks in blas/ext/base/dcusome descriptions#12705

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-commit-review-2026-06-08
Jun 8, 2026
Merged

docs: add backticks in blas/ext/base/dcusome descriptions#12705
kgryte merged 1 commit into
developfrom
philipp/fix-commit-review-2026-06-08

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Follow-up fixes for commits merged to develop between 2026-06-07 05:19 PDT and 2026-06-08 01:55 PDT (SHA range 81c49c2f..f31e14972, 22 first-parent commits).

Description

This pull request:

  • Aligns blas/ext/base/dcusome user-facing documentation with the blas/ext/base/gcusome reference convention by wrapping the k parameter in backticks in README.md, docs/repl.txt, docs/types/index.d.ts, and lib/index.js (originating commit 98254d8e).

Fixes by package

  • blas/ext/base/dcusome — Fixes missing backtick formatting around k in README.md, docs/repl.txt, docs/types/index.d.ts, and lib/index.js, introduced in 98254d8e; gcusome consistently wraps k in backticks across the same surfaces.

Related Issues

No.

Questions

No.

Other

Commit window

22 first-parent commits merged to develop between 2026-06-07 05:19 PDT and 2026-06-08 01:55 PDT (81c49c2f..f31e14972). The window centers on @stdlib/blas/ext/base expansion: new dcuany, dcuevery, dcusome, scunone, dwxsa, gminheap-sift-down packages; new ndarray/{caxpby,daxpby,saxpby} wrappers; a caxpby/src/main.c refactor; benchmark description format fixes; and namespace + TypeScript declaration updates.

Validation

Scope of review:

  • stdlib code-style compliance against docs/style-guides/ and against established sibling reference packages (gcusome, dcunone, scuany, dnansum, swxsa, zaxpby).
  • Bug scan across all introduced JavaScript and C sources, with focused attention on gminheap-sift-down index arithmetic, dcusome k-threshold semantics, the caxpby C refactor, dwxsa sign direction, and the ndarray/{caxpby,daxpby,saxpby} argument forwarding.

Deliberately excluded:

  • Subjective or "could be improved" suggestions.
  • Findings requiring changes to code outside the 24-hour window (e.g., the dcusome k <= 0 semantic matches the gcusome reference exactly and is covered by an explicit reference test — not a regression).
  • Bench-description format reordering in the three bench: fix description commits, confirmed to be intentional alignment with the new sibling-package convention.

Checklist

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

This PR was assembled by Claude Code as part of a scheduled review of commits merged to develop in the last 24 hours. The documentation fix was identified by automated style auditors, validated against the gcusome reference package, and applied by Claude Code. A maintainer should audit before promoting from draft.



Generated by Claude Code

@stdlib-bot stdlib-bot added the BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). label Jun 8, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/dcusome $\color{green}403/403$
$\color{green}+100.00\%$
$\color{green}20/20$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}403/403$
$\color{green}+100.00\%$

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

@Planeshifter Planeshifter marked this pull request as ready for review June 8, 2026 20:12
@Planeshifter Planeshifter requested review from a team and kgryte June 8, 2026 20:12
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jun 8, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jun 8, 2026
@kgryte kgryte changed the title docs: backtick k parameter in blas/ext/base/dcusome documentation docs: add backticks in blas/ext/base/dcusome descriptions Jun 8, 2026
@kgryte kgryte merged commit c0a017b into develop Jun 8, 2026
56 checks passed
@kgryte kgryte deleted the philipp/fix-commit-review-2026-06-08 branch June 8, 2026 20:42
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants