acknowledge deferred work

endojs · Jan 10, 2024 · caf606f · caf606f
1 parent 8246acd
commit caf606f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/packages/marshal/src/types.js b/packages/marshal/src/types.js
@@ -172,8 +172,8 @@ export {};
  * ordering would also compare magnitudes, and so agree with the rank ordering
  * of all values other than `NaN`. An array sorted by rank would enable range
  * queries by magnitude.
- * @param {any} left a Passable
- * @param {any} right a Passable
+ * @param {Passable} left
+ * @param {Passable} right
  * @returns {RankComparison}
  */
 

diff --git a/packages/pass-style/src/types.js b/packages/pass-style/src/types.js
@@ -127,13 +127,15 @@ export {};
  * The authority-bearing leaves of a Passable's pass-by-copy superstructure.
  */
 
+// TODO a better default type. Ideally it's Passable, but that causes a circular definition.
 /**
  * @template {Passable} [T=object]
  * @typedef {T[]} CopyArray
  *
  * A Passable sequence of Passable values.
  */
 
+// TODO a better default type. Ideally it's Passable, but that causes a circular definition.
 /**
  * @template {Passable} [T=object]
  * @typedef {Record<string, T>} CopyRecord

diff --git a/packages/patterns/src/types.js b/packages/patterns/src/types.js
@@ -21,6 +21,7 @@ export {};
 /** @typedef {import('@endo/marshal').RankCompare} RankCompare */
 /** @typedef {import('@endo/marshal').RankCover} RankCover */
 
+// FIXME exclude nested Error and Promise
 /**
  * @typedef {Exclude<Passable, Error | Promise>} Key
  *
@@ -60,6 +61,7 @@ export {};
  * @returns {string}
  */
 
+// FIXME exclude nested Error and Promise
 /**
  * @typedef {Exclude<Passable, Error | Promise>} Pattern
  *