Skip to content

docs: update descriptions #15653

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 1 commit into from
Sep 30, 2026
Merged

docs: update descriptions #15653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/ndarray/dnanrange/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import { float64ndarray } from '@stdlib/types/ndarray';

/**
* Computes the range of a one-dimensional double-precision floating-point ndarray, ignoring NaN values.
* Computes the range of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values.
*
* ## Notes
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/ndarray/dnanrangeabs/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import { float64ndarray } from '@stdlib/types/ndarray';

/**
* Computes the range of absolute values of a one-dimensional double-precision floating-point ndarray, ignoring NaN values.
* Computes the range of absolute values of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values.
*
* ## Notes
*
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1326,7 +1326,7 @@ interface Namespace {
dnanmskrange: typeof dnanmskrange;

/**
* Computes the range of a one-dimensional double-precision floating-point ndarray, ignoring NaN values.
* Computes the range of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values.
*
* ## Notes
*
Expand All @@ -1348,7 +1348,7 @@ interface Namespace {
dnanrange: typeof dnanrange;

/**
* Computes the range of absolute values of a one-dimensional double-precision floating-point ndarray, ignoring NaN values.
* Computes the range of absolute values of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values.
*
* ## Notes
*
Expand Down Expand Up @@ -3998,7 +3998,7 @@ interface Namespace {
snanmeanwd: typeof snanmeanwd;

/**
* Computes the mid-range of a one-dimensional single-precision floating-point ndarray, ignoring NaN values.
* Computes the mid-range of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values.
*
* ## Notes
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/ndarray/snanmidrange/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import { float32ndarray } from '@stdlib/types/ndarray';

/**
* Computes the mid-range of a one-dimensional single-precision floating-point ndarray, ignoring NaN values.
* Computes the mid-range of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values.
*
* ## Notes
*
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/stats/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1242,7 +1242,7 @@ interface Namespace {
nanmin: typeof nanmin;

/**
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring NaN values.
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.
*
* @param x - input ndarray
* @param options - function options
Expand Down Expand Up @@ -1342,7 +1342,7 @@ interface Namespace {
nanrange: typeof nanrange;

/**
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring NaN values.
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.
*
* @param x - input ndarray
* @param options - function options
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/stats/incr/nanmmeanstdev/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import { ArrayLike } from '@stdlib/types/array';
type accumulator = ( x?: number ) => ArrayLike<number> | null;

/**
* Returns an accumulator function which incrementally computes a moving arithmetic mean and corrected sample standard deviation, ignoring NaN values.
* Returns an accumulator function which incrementally computes a moving arithmetic mean and corrected sample standard deviation, ignoring `NaN` values.
*
* ## Notes
*
Expand All @@ -54,7 +54,7 @@ type accumulator = ( x?: number ) => ArrayLike<number> | null;
declare function incrnanmmeanstdev( out: ArrayLike<number>, window: number ): accumulator;

/**
* Returns an accumulator function which incrementally computes a moving arithmetic mean and corrected sample standard deviation, ignoring NaN values.
* Returns an accumulator function which incrementally computes a moving arithmetic mean and corrected sample standard deviation, ignoring `NaN` values.
*
* ## Notes
*
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/stats/nanmin-by/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,11 @@ interface Options extends BaseOptions {
}

/**
* Interface for performing a reduction on an ndarray according to a callback function, ignoring NaN values.
* Interface for performing a reduction on an ndarray according to a callback function, ignoring `NaN` values.
*/
interface Unary {
/**
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring NaN values.
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.
*
* @param x - input ndarray
* @param clbk - callback function
Expand All @@ -129,7 +129,7 @@ interface Unary {
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): OutputArray<number>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.

/**
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring NaN values.
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.
*
* @param x - input ndarray
* @param options - function options
Expand All @@ -152,7 +152,7 @@ interface Unary {
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, options: Options, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): OutputArray<number>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.

/**
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring NaN values, and assigns results to a provided output ndarray.
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring `NaN` values, and assigns results to a provided output ndarray.
*
* @param x - input ndarray
* @param out - output ndarray
Expand Down Expand Up @@ -180,7 +180,7 @@ interface Unary {
assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends OutputArray<unknown> = OutputArray<unknown>, ThisArg = unknown>( x: U, out: V, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): V;

/**
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring NaN values, and assigns results to a provided output ndarray.
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring `NaN` values, and assigns results to a provided output ndarray.
*
* @param x - input ndarray
* @param out - output ndarray
Expand Down Expand Up @@ -210,7 +210,7 @@ interface Unary {
}

/**
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring NaN values.
* Computes the minimum value along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.
*
* @param x - input ndarray
* @param options - function options
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/stats/nanrange-by/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,11 @@ interface Options extends BaseOptions {
}

/**
* Interface for performing a reduction on an ndarray according to a callback function, ignoring NaN values.
* Interface for performing a reduction on an ndarray according to a callback function, ignoring `NaN` values.
*/
interface Unary {
/**
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring NaN values.
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.
*
* @param x - input ndarray
* @param clbk - callback function
Expand All @@ -129,7 +129,7 @@ interface Unary {
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): OutputArray<number>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.

/**
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring NaN values.
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.
*
* @param x - input ndarray
* @param options - function options
Expand All @@ -152,7 +152,7 @@ interface Unary {
<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, options: Options, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): OutputArray<number>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.

/**
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring NaN values, and assigns results to a provided output ndarray.
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring `NaN` values, and assigns results to a provided output ndarray.
*
* @param x - input ndarray
* @param out - output ndarray
Expand Down Expand Up @@ -180,7 +180,7 @@ interface Unary {
assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends OutputArray<unknown> = OutputArray<unknown>, ThisArg = unknown>( x: U, out: V, clbk: Callback<T, U, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, ThisArg>> ): V;

/**
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring NaN values, and assigns results to a provided output ndarray.
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring `NaN` values, and assigns results to a provided output ndarray.
*
* @param x - input ndarray
* @param out - output ndarray
Expand Down Expand Up @@ -210,7 +210,7 @@ interface Unary {
}

/**
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring NaN values.
* Computes the range along one or more ndarray dimensions according to a callback function, ignoring `NaN` values.
*
* @param x - input ndarray
* @param options - function options
Expand Down
Loading