From 5f00c0a126a2193f4d0d35ae238438bb42381a24 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 29 Sep 2026 13:22:58 +0000 Subject: [PATCH] docs: use inline code for `NaN` in `stats` TypeScript declarations Propagates fix from 8ae6d6499 ("docs: update description") to sibling packages carrying the same unbackticked `NaN` in TypeScript declaration descriptions. Commits 8ae6d6499, 02bbe4011, and 5c4b61336 rendered `NaN` as inline code in JSDoc description lines within `docs/types/index.d.ts`. These 22 lines across eight files were the remaining plain occurrences of that phrasing in the file type, against 873 already using the inline code form. The namespace entries in `stats/docs/types/index.d.ts` and `stats/base/ndarray/docs/types/index.d.ts` are updated together with the member package declarations they are generated from, so nightly regeneration of the namespace declarations remains a no-op. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01VYzCUqHiEst6mVYhP72gSS --- .../base/ndarray/dnanrange/docs/types/index.d.ts | 2 +- .../base/ndarray/dnanrangeabs/docs/types/index.d.ts | 2 +- .../@stdlib/stats/base/ndarray/docs/types/index.d.ts | 6 +++--- .../base/ndarray/snanmidrange/docs/types/index.d.ts | 2 +- lib/node_modules/@stdlib/stats/docs/types/index.d.ts | 4 ++-- .../stats/incr/nanmmeanstdev/docs/types/index.d.ts | 4 ++-- .../@stdlib/stats/nanmin-by/docs/types/index.d.ts | 12 ++++++------ .../@stdlib/stats/nanrange-by/docs/types/index.d.ts | 12 ++++++------ 8 files changed, 22 insertions(+), 22 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanrange/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dnanrange/docs/types/index.d.ts index 6414b617c989..19225cc48103 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanrange/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanrange/docs/types/index.d.ts @@ -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 * diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanrangeabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dnanrangeabs/docs/types/index.d.ts index 72285b6badce..b495ef8a5eee 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanrangeabs/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanrangeabs/docs/types/index.d.ts @@ -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 * diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts index 190a54aff759..24fcc58f2fba 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts @@ -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 * @@ -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 * @@ -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 * diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmidrange/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanmidrange/docs/types/index.d.ts index 5affc44801bd..90b16d14f7a8 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanmidrange/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmidrange/docs/types/index.d.ts @@ -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 * diff --git a/lib/node_modules/@stdlib/stats/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/docs/types/index.d.ts index 586c9a42142c..b5e7391be6c7 100644 --- a/lib/node_modules/@stdlib/stats/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/docs/types/index.d.ts @@ -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 @@ -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 diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmeanstdev/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmmeanstdev/docs/types/index.d.ts index fc5436e50ad9..3b86dba0df4c 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmeanstdev/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/incr/nanmmeanstdev/docs/types/index.d.ts @@ -31,7 +31,7 @@ import { ArrayLike } from '@stdlib/types/array'; type accumulator = ( x?: number ) => ArrayLike | 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 * @@ -54,7 +54,7 @@ type accumulator = ( x?: number ) => ArrayLike | null; declare function incrnanmmeanstdev( out: ArrayLike, 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 * diff --git a/lib/node_modules/@stdlib/stats/nanmin-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/nanmin-by/docs/types/index.d.ts index 291fd7b857f5..402db54ad0fa 100644 --- a/lib/node_modules/@stdlib/stats/nanmin-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/nanmin-by/docs/types/index.d.ts @@ -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 @@ -129,7 +129,7 @@ interface Unary { = InputArray, ThisArg = unknown>( x: U, clbk: Callback, thisArg?: ThisParameterType> ): OutputArray; // 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 @@ -152,7 +152,7 @@ interface Unary { = InputArray, ThisArg = unknown>( x: U, options: Options, clbk: Callback, thisArg?: ThisParameterType> ): OutputArray; // 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 @@ -180,7 +180,7 @@ interface Unary { assign = InputArray, V extends OutputArray = OutputArray, ThisArg = unknown>( x: U, out: V, clbk: Callback, thisArg?: ThisParameterType> ): 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 @@ -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 diff --git a/lib/node_modules/@stdlib/stats/nanrange-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/nanrange-by/docs/types/index.d.ts index 95fec2ed5c2e..bcf384b388e5 100644 --- a/lib/node_modules/@stdlib/stats/nanrange-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/nanrange-by/docs/types/index.d.ts @@ -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 @@ -129,7 +129,7 @@ interface Unary { = InputArray, ThisArg = unknown>( x: U, clbk: Callback, thisArg?: ThisParameterType> ): OutputArray; // 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 @@ -152,7 +152,7 @@ interface Unary { = InputArray, ThisArg = unknown>( x: U, options: Options, clbk: Callback, thisArg?: ThisParameterType> ): OutputArray; // 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 @@ -180,7 +180,7 @@ interface Unary { assign = InputArray, V extends OutputArray = OutputArray, ThisArg = unknown>( x: U, out: V, clbk: Callback, thisArg?: ThisParameterType> ): 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 @@ -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