docs: update jsdoc

src/accessors/accessors.ts

@@ -13,7 +13,7 @@ export function get<T extends object>(obj: T, path: LeafPath<T>) {
   return _.get(obj, path) as LeafValue<T>;
 }
 
-/** Checks whether the path refers to a leaf value */
+/** Check whether the path refers to a leaf value */
 export function has<T extends object>(obj: T, path: LeafPath<T>) {
   path = interpretPathHints(path);
   const parent = _.get(obj, _.toPath(path).slice(0, -1));
@@ -30,7 +30,7 @@ export function has<T extends object>(obj: T, path: LeafPath<T>) {
   }
 }
 
-/** in-place setter for a deeply nested value */
+/** Set a leaf value by path in-place. */
 export function set<T extends object>(
   obj: T,
   // eslint-disable-next-line @typescript-eslint/ban-types

src/accessors/findDifference.ts

@@ -2,11 +2,12 @@ import { get } from './accessors.js';
 import { Fragment } from '@typings';
 import walkLeaves from './walkLeaves.js';
 
-/** Find the differences between an object and it's modified clone (of same type)
+/** Find the differences between an object and a modified subset of it
  * @param original imagined as an immutable state object,
  * whose properties can be thought of as the "original" ones.
  * @param fragment a modified clone or subset of `original`,
  * imagined as mutable and intended for making changes to.
+ * @yields a pair with a leaf path and the changed value inside `fragment`
  */
 export default function* findDifference<T extends object>(
   original: T,

src/accessors/toTree.ts

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import { set } from './accessors.js';
 import { Primitive } from '@typings';
 
-/** from path-value pairs to object */
+/** Create a new object from a list of path-value entries  */
 
 export default function toTree(
   leaves: readonly (readonly [string, Primitive])[],

src/accessors/walkLeaves.ts

@@ -1,6 +1,7 @@
 import _ from 'lodash';
 import { Primitive, LeafPath } from '@typings';
 
+/** Generate the leaf value entries inside the object */
 export default function* walkLeaves<T extends object>(
   target: T,
 ): Generator<readonly [LeafPath<T>, Primitive], undefined> {