From 10a97679ac80b4304c75d33cbc59c5736d11deb1 Mon Sep 17 00:00:00 2001 From: Kitson Kelly Date: Mon, 15 Oct 2018 07:29:50 +1100 Subject: Align JSDoc to style guide. --- js/trace.ts | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) (limited to 'js/trace.ts') 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 -- cgit v1.2.3