Skip to content

Commit

Permalink
docs(internal): add module docs (#4757)
Browse files Browse the repository at this point in the history
  • Loading branch information
iuioiua authored May 17, 2024
1 parent a724d90 commit 1eeb5f9
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions internal/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,35 @@
*
* Note: this module is for internal use only and should not be used directly.
*
* ```ts
* import { diff, diffstr, buildMessage } from "@std/internal";
* import { assertEquals } from "@std/assert/assert-equals";
*
* const a = [1, 2, 3];
* const b = [1, 2, 4];
*
* assertEquals(diff(a, b), [
* { type: "common", value: 1 },
* { type: "common", value: 2 },
* { type: "removed", value: 3 },
* { type: "added", value: 4 },
* ]);
*
* const diffResult = diffstr("Hello, world!", "Hello, world");
*
* console.log(buildMessage(diffResult));
* // [
* // "",
* // "",
* // " [Diff] Actual / Expected",
* // "",
* // "",
* // "- Hello, world!",
* // "+ Hello, world",
* // "",
* // ]
* ```
*
* @module
*/
export * from "./build_message.ts";
Expand Down

0 comments on commit 1eeb5f9

Please sign in to comment.