docs: propagate fixes to sibling packages#11843
Merged
Conversation
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
…ile` Propagates fix from 9fedcf9 ("docs: fix parameter descriptions in `stats/base/dists/lognormal`") to the top-level quantile JSDoc in `stats/base/dists/lognormal/quantile/docs/types/index.d.ts` that still labeled `mu` as "mean" and `sigma` as "standard deviation". For the lognormal distribution, `mu` and `sigma` are the location and scale parameters of the underlying normal, not the mean/std of the lognormal itself. The matching JSDoc blocks in `stats/base/dists/lognormal/docs/types/ index.d.ts` were dropped from this propagation: that file fails the TypeScript-declarations lint on pre-existing example value mismatches in the `logpdf` block (lines 176/179, introduced in cfc58ab) which are out of scope for this fix.
006f249 to
f23b344
Compare
…E directives Propagates fix from d689d2d ("chore: propagate `node/` -> `n/` eslint plugin prefix update across README directives") to 50 README files under `lib/node_modules/@stdlib/` that still carried `node/no-sync` ESLint directives. The `eslint-plugin-node` package was renamed to `eslint-plugin-n` (see 0dc62ae, c7d0cd5). Includes one inline-config form (`<!-- eslint ... n/no-sync: "off" -->`) in `_tools/remark/plugins/remark-includes/README.md` for namespace consistency, since leaving it as `node/no-sync` would cause remark-lint-eslint to emit "Definition for rule 'node/no-sync' was not found". Two READMEs were dropped from the propagation because their `Lint Markdown files` checks fail on pre-existing issues unrelated to this fix: - `blas/ext/base/wasm/dapx/README.md` (mismatched section class at line 245: `<section class="notes">` closed by `<!-- /.usage -->`) - `fs/append-file/README.md` (`no-restricted-syntax`: uses `fs.existsSync` instead of `@stdlib/fs/exists` in an example block) --- 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: skipped - task: lint_markdown status: skipped - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - 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: na - task: lint_license_headers status: passed ---
f23b344 to
109365b
Compare
kgryte
approved these changes
May 1, 2026
Member
|
As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge. |
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
This pull request:
developbetween 2026-04-28 18:13 UTC and 2026-04-29 13:30 UTC to sibling packages that share the same defect.docs: fix parameter descriptions in stats/base/dists/lognormal/quantilePropagates 9fedcf9, which corrected
muandsigmadescriptions from "mean"/"standard deviation" to "location parameter"/"scale parameter" across thelogcdfsubmodule. The same correction was missed in the top-level quantile JSDoc atstats/base/dists/lognormal/quantile/docs/types/index.d.ts:107-108. Surrounding prose was already accurate; only the@paramtag descriptions required updating.Target package:
lib/node_modules/@stdlib/stats/base/dists/lognormal/quantile/docs/types/index.d.tsTwo further sites in
lib/node_modules/@stdlib/stats/base/dists/lognormal/docs/types/index.d.ts(lines 142-143 and 313-314) were dropped from this run. That file failsLint Changed Fileson pre-existing JSDoc example value mismatches in thelogpdfblock at lines 176/179 —// returns ~-4.269and// returns ~-3.689should be~-4.275/~-3.672(introduced incfc58ab9b, unrelated to the propagation). Those sites need a separate PR that also corrects thelogpdfexample values.chore: propagate node/no-sync → n/no-sync across remaining README directivesCompletes the
node/no-sync→n/no-syncrename started in d689d2d, which swept README ESLint directives following theeslint-plugin-node→eslint-plugin-nrename tracked in earlier commits (0dc62ae, c7d0cd5). This PR covers 50 README files and 143 ESLint-directive instances underlib/node_modules/@stdlib/that d689d2d did not reach, including one inline-config variant in_tools/remark/plugins/remark-includes/README.md:96. That inline-config rename is required for correctness, not just consistency: leaving it asnode/no-synccausesremark-lint-eslintto emitDefinition for rule 'node/no-sync' was not foundbecause the plugin no longer exposes that rule name.Two READMEs were dropped from the propagation because their
Lint Markdown fileschecks fail on pre-existing issues unrelated to this fix:blas/ext/base/wasm/dapx/README.md— mismatched section class at line 245 (<section class="notes">closed by<!-- /.usage -->)fs/append-file/README.md—no-restricted-syntax: usesfs.existsSyncinstead of@stdlib/fs/existsin an example block at lines 101-108Target packages (50):
_tools/remark/plugins/remark-includes;blas/base/wasm/{ccopy,cscal,csrot,cswap,dasum,daxpy,dcopy,ddot,dnrm2,drot,drotm,dscal,dsdot,dswap,dznrm2,idamax,isamax,sasum,saxpy,scasum,scnrm2,scopy,sdot,sdsdot,snrm2,srot,srotm,sscal,sswap,zcopy,zdrot,zscal,zswap};blas/ext/base/wasm/{dapxsum,dapxsumkbn,dapxsumors,dapxsumpw,dasumpw,dnanasumors,dnansumkbn2,dnansumpw,sapxsumkbn};stats/strided/wasm/{dmeanors,dmeanpw,dmeanwd,dnanvariancewd};utils/{dirname,extname,parallel}.Related Issues
No.
Questions
No.
Other
Validation
lib/node_modules/@stdlib/stats/base/dists/lognormal/**for the JSDoc param fix;lib/node_modules/@stdlib/**/README.mdfor the ESLint plugin-namespace rename.node/no-syncoccurrence sat inside an HTML-comment ESLint directive in a README).dapx,fs/append-file) carry pre-existing structural errors unrelated to this propagation and were dropped.Deliberately excluded
refactor: remove duplicated assignments(16f0b29) — single-file cleanup inblas/ext/base/dcartesian-square/src/main.c. The single sibling (scartesian-square) was committed after the fix and already in the corrected form; no other BLAS C source matched the sameif (isrm) { ... } else { ... }duplicate-hoisting shape.lognormal/docs/types/index.d.ts— dropped after CI flagged pre-existing TypeScript-declarations lint errors in that file'slogpdfblock (returns ~-4.269/~-3.689versus actual~-4.275/~-3.672, introduced incfc58ab9b).lib/node_modules/@stdlib/blas/ext/base/wasm/dapx/README.md— dropped after Lint Changed Files surfaced a pre-existingmismatched-section-classerror at line 245.lib/node_modules/@stdlib/fs/append-file/README.md— dropped after Lint Changed Files surfaced a pre-existingno-restricted-syntaxerror (fs.existsSyncused instead of@stdlib/fs/exists) at lines 101-108.// eslint-disable-line node/no-syncin_tools/utils/jsdelivr-url/bin/cliandutils/library-manifest/bin/cli— non-README, outside the source commit's stated scope.docs: update REPL namespace documentation(52dd2b8) and asset-only commits (docs: add hpsf talk,docs: add Zen of stdlib) — no propagable pattern.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 fix-propagation routine. Claude enumerated
fix:/docs:/chore:commits merged todevelopin the last 24 hours, distilled fix patterns, searched for sibling sites, and ran independent validation and style-consistency passes before applying mechanical text replacements. After the initial push, three CI failures (TypeScript-declarations lint and two markdown-lint annotations) surfaced pre-existing issues in three of the touched files (lognormal/docs/types/index.d.ts,dapx/README.md,fs/append-file/README.md); all three files were dropped from the propagation per the routine's "if a pre-existing lint failure surfaces in a touched file, drop that file" guidance. The PR is filed as a draft for human audit before promotion.@stdlib-js/reviewers