8000 Docs: Fix formatting error (#2250) · gulpjs/gulp@ca6ba35 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Commit ca6ba35

Browse files
janiceilenephated
authored andcommitted
Docs: Fix formatting error (#2250)
1 parent c960c1d commit ca6ba35

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/api/symlink.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,15 @@ When `directory` is a function that returns an empty string or `undefined`, emit
7171

7272
## Symbolic links on Windows
7373

74-
When creating symbolic links on Windows, a `type` argument is passed to Node's `fs.symlink()` method which specifies the type of target being linked. The link type is set to:
75-
`'file'` when the target is a regular file
76-
`'junction'` when the target is a directory
77-
`'dir'` when the target is a directory and the user disables the `useJunctions` option
74+
When creating symbolic links on Windows, a `type` argument is passed to Node's `fs.symlink()` method which specifies the type of target being linked. The link type is set to:
75+
* `'file'` when the target is a regular file
76+
* `'junction'` when the target is a directory
77+
* `'dir'` when the target is a directory and the user disables the `useJunctions` option
7878

7979

8080
If you try to create a dangling (pointing to a non-existent target) link, the link type can't be determined automatically. In these cases, behavior will vary depending on whether the dangling link is being created via `symlink()` or via `dest()`.
8181

82-
For dangling links created via `symlink()`, the incoming Vinyl object represents the target, so its stats will determine the desired link type. If `isDirectory()` returns false then a `'file'` link is created, otherwise a `'junction'` or a `'dir'` link is created depending on the value of the `useJunctions` option.
82+
For dangling links created via `symlink()`, the incoming Vinyl object represents the target, so its stats will determine the desired link type. If `isDirectory()` returns false then a `'file'` link is created, otherwise a `'junction'` or `'dir'` link is created depending on the value of the `useJunctions` option.
8383

8484
For dangling links created via `dest()`, the incoming Vinyl object represents the link - typically loaded from disk via `src(..., { resolveSymlinks: false })`. In this case, the link type can't be reasonably determined and defaults to using `'file'`. This may cause unexpected behavior when creating a dangling link to a directory. **Avoid this scenario.**
8585

0 commit comments

Comments
 (0)
0