Skip to content

Commit

Permalink
add comment about symlinks #47475
Browse files Browse the repository at this point in the history
  • Loading branch information
jrieken committed May 2, 2018
1 parent e07f8ab commit 5a397a1
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/vs/vscode.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4832,7 +4832,7 @@ declare module 'vscode' {
}

/**
* The `FileStat`-type represents metadata about a file.
* The `FileStat`-type represents metadata about a file
*/
export interface FileStat {
/**
Expand Down Expand Up @@ -4982,6 +4982,10 @@ declare module 'vscode' {
/**
* Retrieve metadata about a file.
*
* Note that the metadata for symbolic links should be the metadata of the file they refer to.
* Still, the [SymbolicLink](#FileType.SymbolicLink)-type must be used in addition to the actual type, e.g.
* `FileType.SymbolicLink | FileType.Directory`.
*
* @param uri The uri of the file to retrieve metadata about.
* @return The file metadata about the file.
* @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
Expand Down

0 comments on commit 5a397a1

Please sign in to comment.