issue-#57 - Updated some '_platform' module docs.

packages/fjl/src/_platform/README.md

@@ -1,6 +1,5 @@
-## platform/
+## _platform/
 
 Platform specific, "functional version" methods. 
 
-*Note:* This directory doesn't get exported in the project, directly, however modules from this directory get exported via other exports (in '../function', '../object' modules, etc., for example), usually under aliases, or are just used in those (other) modules, etc..
-
+*Note:* This directory doesn't get exported "directly" in the project, instead it is exported as the `platform` module.  Additionally, some of its members get individually exported by other modules (for instance `instanceOf` gets exported by '../object' module as well).

packages/fjl/src/_platform/index.ts

@@ -1,5 +1,5 @@
 /**
- * @module platform
+ * @module _platform
  */
 export * from './object';
 export * from './slice';

packages/fjl/src/_platform/object/index.ts

@@ -1,7 +1,6 @@
 /**
- * Defines (object) platform functional method counter-parts used in the library.
+ * Defines `Object` platform functional method counter-parts used in the library.
  */
-
 import {flip, flip3, flip4, flip5} from "../../function/flip";
 import {Constructable, ObjectStatics} from "../../types";
 
@@ -67,17 +66,29 @@ export const
     return agg;
   }, {}) as ObjectStatics,
 
+  /**
+   * Functional version of `instanceof` operator.
+   */
   instanceOf = (x: any, X: Constructable): boolean =>
     x.constructor === X || x instanceof X,
 
+  /**
+   * Curried version of `instanceOf`.
+   */
   $instanceOf = (x: any) => (X: Constructable): boolean => instanceOf(x, X),
 
+  /**
+   * Functional version of `Object.prototype.hasOwnProperty`.
+   */
   hasOwnProperty = Object.hasOwn ?? (<T extends object>(x: T, key: string | PropertyKey): boolean =>
     // @note `Object.hasOwn` cannot be used here until it is more broadly
     //   adopted (until node v24+ release etc.).
     Object.prototype.hasOwnProperty.call(x, key))
   ,
 
+  /**
+   * Curried version of `hasOwnProperty`.
+   */
   $hasOwnProperty = <T extends object>(x: T) =>
     (key: string | PropertyKey): boolean => hasOwnProperty(x, key)
 

packages/fjl/src/_platform/slice/index.ts

@@ -1,3 +1,6 @@
+/**
+ * Methods that apply to the `Slice` Sum Type (e.g., intersection of `Array` and `String` types).
+ */
 export const
 
   /**

packages/fjl/src/_platform/string/index.ts

@@ -1,3 +1,6 @@
+/**
+ * Platform (string) specific combinators.
+ */
 export const split = (pattern: string | RegExp, xs: string, limit?: number): string[] => xs?.split(pattern, limit),
 
   $split = (p: string) => (xs: string): string[] => split(p, xs);