Document overload

kgryte · kgryte · commit cd61dde63408 · 2019-08-29T14:39:19.000-07:00
diff --git a/lib/node_modules/@stdlib/iter/logspace/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/logspace/docs/types/index.d.ts
@@ -66,6 +66,38 @@ interface Options {
 * // ...
 */
 declare function iterLogspace( start: number, stop: number, N: number, options?: Options ): Iterator; // tslint:disable-line: max-length
+
+/**
+* Returns an iterator which returns evenly spaced numbers on a log scale.
+*
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
+* @param start - exponent of starting value (inclusive)
+* @param stop - exponent of stopping value (inclusive)
+* @param options - function options
+* @param options.base - base of log space (default: 10)
+* @throws `base` option must be a positive number
+* @returns iterator
+*
+* @example
+* var opts = {
+*     'base': 2
+* };
+* var iter = iterLogspace( 0, 99, opts );
+*
+* var v = iter.next().value;
+* // returns 1
+*
+* v = iter.next().value;
+* // returns 2
+*
+* v = iter.next().value;
+* // returns 4
+*
+* // ...
+*/
 declare function iterLogspace( start: number, stop: number, options?: Options ): Iterator; // tslint:disable-line: max-length
 
 
