add better documentation comments to lib.runTests

       traceSeqN 2 { a.b.c = 3; } null

       trace: { a = { b = {…}; }; }

       => null

     Type: traceSeqN :: Int -> a -> b -> b

   */

  traceSeqN = depth: x: y:

    let snip = v: if      isList  v then noQuotes "[…]" v

  # -- TESTING --

  /* Evaluate a set of tests.  A test is an attribute set `{expr,

     expected}`, denoting an expression and its expected result.  The

     result is a list of failed tests, each represented as `{name,

     expected, actual}`, denoting the attribute name of the failing

  /* Evaluates a set of tests.

     A test is an attribute set `{expr, expected}`,

     denoting an expression and its expected result.

     The result is a `list` of __failed tests__, each represented as

     `{name, expected, result}`,

     - expected

       - What was passed as `expected`

     - result

       - The actual `result` of the test

     Denoting the attribute name of the failing

     test and its expected and actual results.

     Used for regression testing of the functions in lib; see

     tests.nix for an example. Only tests having names starting with

     tests.nix for an example.

     > Important: In general only `tests` having names starting with

     "test" are run.

     Add attr { tests = ["testName"]; } to run these tests only.

     - Add attr { tests = ["testName"]; } to run tests from list only.

     - If `tests` in not specififed all tests will be evaluated.

    Example:

     runTests {

       testAndOk = {

         expr = lib.and true false;

         expected = false;

       };

       testAndFail = {

         expr = lib.and true false;

         expected = true;

       };

     }

     ->

     [

       {

         name = "testAndFail";

         expected = true;

         result = false;

       }

     ]

    Type:

      runTests :: {

        tests = [ String ];

        ${testName} :: {

          expr :: a;

          expected :: a;

        };

      }

      ->

      [

        {

          name :: String;

          expected :: a;

          result :: a;

        }

      ]

  */

  runTests =

    # Tests to run