Skip to content

docs: fix examples - #14526

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-commit-review-2026-08-22
Aug 22, 2026
Merged

kgryte merged 1 commit into
developfrom
philipp/fix-commit-review-2026-08-22

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

Follow-up fixes for commits merged to develop between 2026-08-21 17:11 PDT (5fa117b) and 2026-08-22 05:09 PDT (8e32669).

This pull request:

  • ml/base/sgd/params/factory:
    • Fix toString() docs in @stdlib/ml/base/sgd/params/factory (8e32669): README.md and examples/index.js call params.toString({ 'format': 'linear' }), but format isn't a recognized option — only digits is, per to-string's ToStringOptions. Drop the bogus argument in both files to match the float64/float32 sibling docs.
    • Fix factory's @example in lib/node_modules/@stdlib/ml/base/sgd/params/factory/lib/main.js: penaltyParams and learningRateParams were assigned Float32Array (copy-paste from the float32 variant introduced in 8e32669), inconsistent with the float64 factory, @stdlib/array/float64 require, and lossFunctionParams. Switched both to Float64Array to match lib/index.js and the README.

Related Issues

Does this pull request have any related issues?

No.

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 performed on all 41 commits merged to develop in the review window:

  • Style guide compliance audit (docs/style-guides) of new packages (ml/base/sgd/params/*, fft/base/fftpack/*, blas/ext/base/gfill-greater-than, new C implementations) against established sibling packages.
  • Bug scan of all per-commit diffs, including the fromIndex offset/clip arithmetic, the rayleigh/quantile overflow fix, FFTPACK twiddle-factor ports, and the format() argument fixes — all verified clean.

Deliberately excluded: subjective concerns, style preferences not required by the style guides, and anything requiring changes outside the review window's diffs to validate.

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

This PR was authored by Claude Code as part of an automated review of commits merged to develop in the last 24 hours; the documentation/example fixes were generated and validated by Claude Code.


Generated by Claude Code

Removes a non-existent `format` option from `toString()` calls in the
README and examples (the `to-string` package only supports a `digits`
option) and corrects a copy-paste error in the `factory` JSDoc example
in which `Float32Array` values were assigned to a `float64` parameters
object.
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
ml/base/sgd/params/factory $\\color{green}562/562$
$\\color{green}+100.00\\%$
$\\color{green}41/41$
$\\color{green}+100.00\\%$
$\\color{green}13/13$
$\\color{green}+100.00\\%$
$\\color{green}562/562$
$\\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 August 22, 2026 12:54
@kgryte
kgryte requested a review from a team August 22, 2026 12:54
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Aug 22, 2026
@kgryte kgryte changed the title docs: fix examples in ml/base/sgd/params/factory docs: fix examples Aug 22, 2026
@kgryte
kgryte merged commit 97bc924 into develop Aug 22, 2026
36 checks passed
@kgryte
kgryte deleted the philipp/fix-commit-review-2026-08-22 branch August 22, 2026 12:54
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Aug 22, 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