Repository navigation
chore: fix inconsistencies across packages in blas/ext/base* - #15146
Conversation
|
@kgryte This ended up being a lot bigger than I expected. The 'fixes' are mostly docs and tests related. I will updated the currently open related PR's as well. |
Coverage Report
The above coverage report was generated for the changes in this PR. |
Signed-off-by: Athan <kgryte@gmail.com>
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| // Initial arrays... | ||
| // Initial arrays: |
There was a problem hiding this comment.
@headlessNode You are too blindly making changes. The general rule is:
- If a comment applies to the next line and next line only, use a colon.
- If a comment applies to multiple lines and/or a block of code, use ellipses.
(1) can be loosened for <= 3 consecutive lines if it is "obvious" that all statements belong to the same comment. As such, we can keep this change; however, to minimize future noise, it is useful to remember the guidance above.
| } | ||
|
|
||
| // Attached to main export is an `ndarray` method which returns a number... | ||
| // Attached to the main export is an `ndarray` method which returns a number... |
There was a problem hiding this comment.
Okay. Looks like this was a false flag. I checked elsewhere in the codebase (other namespaces). And consistently we use Attached to main export. So, no need to deviate here. You can revert everything back to Attached to main export. Sorry for the noise.
|
Np. Fixed the ellipses/colon one as well. |
kgryte
left a comment
There was a problem hiding this comment.
Okay. I went through all the files. Things look fine. A significant amount of technical debt had accumulated, so getting this in sooner rather than later will be good for mitigating further spread.
@headlessNode You may want to check your current PRs once this is merged, as some of those may also need updating.
|
As the CI failure is expected, I'll go ahead and merge. |
blas/ext/base*blas/ext/base*
Resolves stdlib-js/metr-issue-tracker#1316.
Description
This pull request fixes inconsistencies across the index-returning packages in
blas/ext/base. For each family, a canonical structure and wording was established from the family's most consistent member and applied to all siblings.Bird's eye view of the changes:
x(andy) stride, negative strides, view offsets (main), and index offsets (ndarray), each with accessor twins ingpackages; added missing tapes (offsets, complex accessors, arity, no-match-1,NaNcomparison); normalized tape titles, data, and spacing; removed redundant tapes flagged in review.// Standard usage:,// Using `N` and stride parameters:,// Using view offsets:,// Using index offset(s):), added missing stride/offset example blocks,varonly on the first assignment within a section, wrapped description text consistently, and fixed lines exceeding the 80-character render limit.NaN/-0/+0comparison notes, the "If the function is unable to find ... the function returns-1." usage sentence,N <= 0first Notes bullet), parameter bullet style and stride/offset parameter descriptions ("stride length for ...", "starting index for ..."), example data and comment styles across siblings, and restored missing template comments.index.d.ts, added missing$ExpectErrorcases (e.g., function arguments), normalized arity-block arguments, and added missing complex-array imports.lib/*.jsfiles (including.native.js), normalized descriptions and parameter wording, and added matrix visualization comments per family canon.@paramcomment spacing insrc/main.c, normalized NAPI macro ordering insrc/addon.c, canonical comments inexamples/c/example.cand README C sections (// Perform a search:,printf( "index value: %d\n", idx )),constinput arrays, and parameter wording in doc comments.logEach-based logging for complex input arrays, normalized data generation ranges, and corrected benchmark require paths and helper naming.package.json: normalized descriptions and keywords per family conventions.Related Issues
This pull request has the following related issues:
blas/ext/base*metr-issue-tracker#1316.Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
Primarily written by Claude Code.
@stdlib-js/reviewers