summaryrefslogtreecommitdiff
path: root/js/trace.ts
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2018-10-15 07:29:50 +1100
committerRyan Dahl <ry@tinyclouds.org>2018-10-14 17:38:23 -0400
commit10a97679ac80b4304c75d33cbc59c5736d11deb1 (patch)
treeb51b9183ed251f61373069e5c4d35e39603bedb2 /js/trace.ts
parent1840a1971317f5b8fc6e322b3a414b7f8a593c88 (diff)
Align JSDoc to style guide.
Diffstat (limited to 'js/trace.ts')
-rw-r--r--js/trace.ts15
1 files changed, 7 insertions, 8 deletions
diff --git a/js/trace.ts b/js/trace.ts
index 805c76623..104d048de 100644
--- a/js/trace.ts
+++ b/js/trace.ts
@@ -55,17 +55,16 @@ export function maybePushTrace(op: msg.Any, sync: boolean): void {
);
}
-/**
- * Trace operations executed inside a given function or promise.
- * Notice: To capture every operation in asynchronous deno.* calls,
+/** Trace privileged operations executed inside a given function or promise.
+ *
+ * _Notice:_ To capture every operation in asynchronous `deno.*` calls,
* you might want to put them in functions instead of directly invoking.
*
- * import { trace, mkdir } from "deno";
+ * import { trace, mkdir } from "deno";
*
- * const ops = await trace(async () => {
- * await mkdir("my_dir");
- * });
- * // ops becomes [{ sync: false, name: "Mkdir" }]
+ * const ops = await trace(async () => {
+ * await mkdir("my_dir");
+ * });
*/
export async function trace(
// tslint:disable-next-line:no-any