From 9361eb05267b742642eb7c7c849e1736632f7d31 Mon Sep 17 00:00:00 2001 From: Yoshiya Hinosawa Date: Thu, 21 Nov 2024 23:32:23 +0900 Subject: [PATCH] add note about target path --- fs/ensure_symlink.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fs/ensure_symlink.ts b/fs/ensure_symlink.ts index 7efbbf5736d0..10b747d59130 100644 --- a/fs/ensure_symlink.ts +++ b/fs/ensure_symlink.ts @@ -36,7 +36,7 @@ function getSymlinkOption( * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access} * for more information on Deno's permissions system. * - * @param target The source file path as a string or URL. + * @param target The source file path as a string or URL. If it is a relative path string, it have to be relative to the link path. * @param linkName The destination link path as a string or URL. * * @returns A void promise that resolves once the link exists. @@ -115,7 +115,7 @@ export async function ensureSymlink( * @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access} * for more information on Deno's permissions system. * - * @param target The source file path as a string or URL. + * @param target The source file path as a string or URL. If it is a relative path string, it have to be relative to the link path. * @param linkName The destination link path as a string or URL. * @returns A void value that returns once the link exists. *