Repository navigation
docs: fix examples - #14526
Merged
Merged
docs: fix examples#14526
Conversation
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.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
August 22, 2026 12:54
kgryte
approved these changes
Aug 22, 2026
ml/base/sgd/params/factory
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Follow-up fixes for commits merged to
developbetween 2026-08-21 17:11 PDT (5fa117b) and 2026-08-22 05:09 PDT (8e32669).This pull request:
ml/base/sgd/params/factory:toString()docs in@stdlib/ml/base/sgd/params/factory(8e32669): README.md and examples/index.js callparams.toString({ 'format': 'linear' }), butformatisn't a recognized option — onlydigitsis, perto-string'sToStringOptions. Drop the bogus argument in both files to match thefloat64/float32sibling docs.factory's@exampleinlib/node_modules/@stdlib/ml/base/sgd/params/factory/lib/main.js:penaltyParamsandlearningRateParamswere assignedFloat32Array(copy-paste from the float32 variant introduced in 8e32669), inconsistent with thefloat64factory,@stdlib/array/float64require, andlossFunctionParams. Switched both toFloat64Arrayto matchlib/index.jsand the README.Related Issues
No.
Questions
No.
Other
Validation performed on all 41 commits merged to
developin the review window: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.fromIndexoffset/clip arithmetic, therayleigh/quantileoverflow fix, FFTPACK twiddle-factor ports, and theformat()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
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of an automated review of commits merged to
developin the last 24 hours; the documentation/example fixes were generated and validated by Claude Code.Generated by Claude Code