Skip to content

docs: clean-up #13435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 7 commits into from
Jul 12, 2026
Merged

docs: clean-up #13435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c41ab33
style: hoist variable declarations and clean description in `stats/in…
claude Jul 12, 2026
8e9377f
style: hoist variable declarations and clean description in `stats/in…
claude Jul 12, 2026
00f70c9
style: hoist variable declarations in `stats/incr/nanewstdev`
claude Jul 12, 2026
e2f5a89
docs: align README example with sibling docs in `stats/incr/nanmpcorr`
claude Jul 12, 2026
3a6ae46
docs: restore missing NaN example step in `stats/incr/nanmapcorr`
claude Jul 12, 2026
7dabfc8
docs: remove backticks from description in `stats/incr/nanmeanvar`
claude Jul 12, 2026
8073a65
revert: restore inline `var` declarations in `stats/incr/nan*` examples
claude Jul 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/stats/incr/nanmapcorr/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
* ar = accumulator( 3.0, -1.0 );
* // returns ~0.925
*
* ar = accumulator( 3.0, NaN );
* // returns ~0.925
*
* ar = accumulator( 5.0, -9.5 );
* // returns ~0.863
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/incr/nanmeanvar/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/stats/incr/nanmeanvar",
"version": "0.0.0",
"description": "Compute an arithmetic mean and unbiased sample variance incrementally, ignoring `NaN` values.",
"description": "Compute an arithmetic mean and unbiased sample variance incrementally, ignoring NaN values.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/incr/nanmpcorr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ var r = accumulator();
r = accumulator( 2.0, 1.0 ); // [(2.0, 1.0)]
// returns 0.0

r = accumulator( 2.0, NaN ); // [(2.0, 1.0)]
r = accumulator( -2.0, NaN ); // [(2.0, 1.0)]
// returns 0.0

r = accumulator( -5.0, 3.14 ); // [(2.0, 1.0), (-5.0, 3.14)]
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/incr/nanmsumprod/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/stats/incr/nanmsumprod",
"version": "0.0.0",
"description": "Compute a moving sum of products incrementally, ignoring `NaN` values.",
"description": "Compute a moving sum of products incrementally, ignoring NaN values.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/incr/nanpcorr/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/stats/incr/nanpcorr",
"version": "0.0.0",
"description": "Compute a sample Pearson product-moment correlation coefficient, ignoring `NaN` values.",
"description": "Compute a sample Pearson product-moment correlation coefficient, ignoring NaN values.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
Loading