Update docstrings and tests

packages/algorithm/src/iter.ts

@@ -13,7 +13,7 @@
  *
  * @deprecated
  *
- * @param object - The iterable or array-like object of interest.
+ * @param object - The iterable object of interest.
  *
  * @returns A new array of values from the given object.
  *
@@ -33,7 +33,7 @@ export function toArray<T>(object: Iterable<T>): T[] {
 /**
  * Create an object from an iterable of key/value pairs.
  *
- * @param object - The iterable or array-like object of interest.
+ * @param object - The iterable object of interest.
  *
  * @returns A new object mapping keys to values.
  *

packages/algorithm/tests/src/iter.spec.ts

@@ -18,9 +18,10 @@ import { each, every, some, toArray, toObject, zip } from '@lumino/algorithm';
  *   expected results of that iterator.
  */
 export function testIterator<T>(
-  factory: () => [IterableIterator<T>, T[]]
+  factory: () => [IterableIterator<T>, T[]],
+  name = ''
 ): void {
-  describe('yield', () => {
+  describe(`yield ${name}`, () => {
     it('should return the same values in the iterator', () => {
       let [it, results] = factory();
       expect(Array.from(it)).to.deep.equal(results);

packages/algorithm/tests/src/retro.spec.ts

@@ -20,9 +20,9 @@ describe('@lumino/algorithm', () => {
     });
 
     it('should call `retro` on a retroable', () => {
-      let iterator = [1, 2, 3, 4][Symbol.iterator]();
-      let retroable = { retro: () => iterator };
-      expect(retro(retroable)).to.equal(iterator);
+      let data = [1, 2, 3, 4];
+      let retroable = { retro: () => retro(data) };
+      testIterator(() => [retro(retroable), data.slice().reverse()], 'retro');
     });
 
     it('should reverse an array', () => {