docs: add module doc for main module

hugojosefson · Oct 27, 2024 · b2e4529 · b2e4529
1 parent 5588d23
commit b2e4529
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/mod.ts b/mod.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ * This module exports the {@link run} function and its varieties, and the types
+ * that they use.
+ */
+
 export { run } from "./src/run.ts";
 export type { RunOptions } from "./src/run.ts";
 export type { CommandFailure } from "./src/run.ts";