From 6cd46fa3ef4b12f35a60f1a33c7f038c06b5fc71 Mon Sep 17 00:00:00 2001 From: dubiousjim Date: Mon, 2 Mar 2020 10:19:42 -0500 Subject: Cleanup comments and internal variables (#4205) --- cli/js/link.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'cli/js/link.ts') diff --git a/cli/js/link.ts b/cli/js/link.ts index 4d66d1cf9..cd738b1bc 100644 --- a/cli/js/link.ts +++ b/cli/js/link.ts @@ -1,10 +1,11 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "./dispatch_json.ts"; -/** Synchronously creates `newname` as a hard link to `oldname`. +/** Creates `newname` as a hard link to `oldname`. * * Deno.linkSync("old/name", "new/name"); - */ + * + * Requires `allow-read` and `allow-write` permissions. */ export function linkSync(oldname: string, newname: string): void { sendSync("op_link", { oldname, newname }); } @@ -12,7 +13,8 @@ export function linkSync(oldname: string, newname: string): void { /** Creates `newname` as a hard link to `oldname`. * * await Deno.link("old/name", "new/name"); - */ + * + * Requires `allow-read` and `allow-write` permissions. */ export async function link(oldname: string, newname: string): Promise { await sendAsync("op_link", { oldname, newname }); } -- cgit v1.2.3