Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ interface Options {
*
* @param options - function options
* @param options.iter - number of iterations (default: 4503599627370497)
* @throws `iter` option must be a nonpositive integer
* @throws `iter` option must be a nonnegative integer
* @returns iterator
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ type Iterator = Iter | IterableIterator;
*
* ## Notes
*
* - The domain of inverse hyperbolic cotangent is restricted to `(-inf,-1]` and `[1,inf)`. If an iterated value is outside of the domain, the returned iterator returns `NaN`.
* - The domain of inverse hyperbolic cotangent is restricted to `(-infinity,-1]` and `[1,+infinity)`. If an iterated value is outside of the domain, the returned iterator returns `NaN`.
* - If an environment supports `Symbol.iterator` **and** a provided iterator is iterable, the returned iterator is iterable.
*
* @param iterator - input iterator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
type Iterator = Iter | IterableIterator;

/**
* Returns an iterator which iteratively computes the inverse half-value versed sin.
* Returns an iterator which iteratively computes the inverse half-value versed sine.
*
* ## Notes
*
* - The domain of inverse half-value versed sin is restricted to `[0,1]`. If an iterated value is outside of the domain, the returned iterator returns `NaN`.
* - The domain of inverse half-value versed sine is restricted to `[0,1]`. If an iterated value is outside of the domain, the returned iterator returns `NaN`.
* - If an environment supports `Symbol.iterator` **and** a provided iterator is iterable, the returned iterator is iterable.
*
* @param iterator - input iterator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Return value when an input iterator yields a non-numeric value.
*/
invalid?: any;

Check warning on line 35 in lib/node_modules/@stdlib/math/iter/tools/map/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Unexpected any. Specify a different type
}

/**
Expand All @@ -41,7 +41,7 @@
* @param value - iterated value
* @returns result
*/
type Unary = ( value: number ) => any;

Check warning on line 44 in lib/node_modules/@stdlib/math/iter/tools/map/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Unexpected any. Specify a different type

/**
* Returns an iterator which invokes a unary function accepting a single numeric argument for each iterated value.
Expand All @@ -52,6 +52,8 @@
*
* - `value`: iterated value
*
* - If an iterated value is non-numeric (including `NaN`), the returned iterator returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.
*
Comment thread
kgryte marked this conversation as resolved.
Outdated
* - If an environment supports `Symbol.iterator` **and** a provided iterator is iterable, the returned iterator is iterable.
*
* @param iterator - input iterator
Expand Down
Loading