docs: correct grammar in descriptions#12461
Merged
Merged
Conversation
The `mul` and `sub` summaries reused the `add` package's preposition
"to" ("...each element in a strided array `x` to a corresponding
element in a strided array `y`"), which is wrong for these operations:
- `mul` computes `z = x * y`, so the summary should read "...`x` by a
corresponding element...".
- `sub` computes `z = x - y`, so the summary should read "Subtracts
each element in a strided array `y` from a corresponding element in a
strided array `x`..." (i.e. subtract `y` from `x`).
The element-wise math in the examples was already correct; only the
prose was stale. Correct the wording across each package's doc surfaces
(declaration TSDoc, README, REPL help, and `lib` JSDoc summaries).
While here, also correct two stale `sub` README example output
annotations where a `-10.0` result was shown as `0.0`.
The `math/strided/ops` namespace aggregator carries the same summary
text but is generated and will pick up the fix on regeneration.
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown_pkg_readmes
status: passed
- task: lint_markdown_docs
status: na
- task: lint_markdown
status: na
- task: lint_package_json
status: na
- task: lint_repl_help
status: passed
- task: lint_javascript_src
status: passed
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: na
- task: lint_javascript_tests
status: na
- task: lint_javascript_benchmarks
status: na
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: passed
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jun 3, 2026
kgryte
added
the
Documentation
kgryte
changed the title
math/strided/ops/{mul,sub}
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
3 participants
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
This pull request corrects copy-paste summary prose in the
@stdlib/math/strided/ops/muland@stdlib/math/strided/ops/subpackages. Both reused theaddpackage's preposition "to" ("...each element in a strided arrayxto a corresponding element in a strided arrayy"), which is wrong for these operations:mulcomputesz = x * y→ "...xby a corresponding element...".subcomputesz = x - y→ "Subtracts each element in a strided arrayyfrom a corresponding element in a strided arrayx...".The element-wise math in the examples was already correct; only the prose was stale. The wording is corrected across each package's doc surfaces (declaration TSDoc, README, REPL help, and
libJSDoc summaries).While here, two stale
subREADME example output annotations are corrected, where a-10.0result was shown as0.0.The
math/strided/opsnamespace aggregator carries the same summary text but is generated and will pick up the fix on regeneration.Related Issues
No.
Questions
No.
Other
Found via a TypeScript-declaration audit of the
@stdlib/mathnamespace.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
These issues were identified by an automated TypeScript-declaration audit run with Claude Code, and the fixes were prepared by Claude Code under my review.
@stdlib-js/reviewers