From 4ef21e63348fa09edb03911640096657a1a5af62 Mon Sep 17 00:00:00 2001
From: Jean-Yves Moyen <jym@siteimprove.com>
Date: Thu, 5 Dec 2024 10:28:40 +0100
Subject: [PATCH] Clean up

---
 packages/alfa-cache/src/cache.ts | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/packages/alfa-cache/src/cache.ts b/packages/alfa-cache/src/cache.ts
index 7cd41b3798..a0e875dac1 100644
--- a/packages/alfa-cache/src/cache.ts
+++ b/packages/alfa-cache/src/cache.ts
@@ -112,7 +112,7 @@ export namespace Cache {
   export type Key = object;
 
   /**
-   * Create a new cache from an iterable of key-value pairs.
+   * Creates a new cache from an iterable of key-value pairs.
    */
   export function from<K extends Key, V>(
     iterable: Iterable<readonly [K, V]>,
@@ -131,7 +131,7 @@ export namespace Cache {
     : T;
 
   /**
-   * Memoize a method.
+   * Memoizes a method.
    */
   export function memoize<This, Args extends Array<Key>, Return>(
     // When called on an instance's method `target`, `this` is the instance.
@@ -139,7 +139,7 @@ export namespace Cache {
   ): (this: This, ...args: Args) => Return;
 
   /**
-   * Memoize a function
+   * Memoizes a function
    *
    * @remarks
    * When memoizing a recursive function, care must be taken to also memoize the
@@ -200,12 +200,15 @@ export namespace Cache {
         const next = cache.get(
           head,
           // @ts-ignore
-          // If there are no more parameters, we need to call the original function.
-          // In case of method, we need to re-bind it to the original instance.
-          // (we could directly return the result in that case, but since we need
-          // to test `innerArgs.length === 0` anyway, we let that handle it)
+          // If `head` is not in the cache, and there are no more parameters,
+          // we need to call the original function. In case of method, we need
+          // to re-bind it to the original instance.
+          // (we could directly return the result in that case, instead of going
+          // to the next call to `memoized`; but since we need to test
+          // `innerArgs.length === 0` anyway, we let that handle it)
           //
-          // If there are more parameters, we just create an empty cache.
+          // If `head` is not in the cache but there are more parameters,
+          // we just create an empty cache.
           tail.length === 0 ? () => target.bind(that)(...args) : Cache.empty,
         );