Skip to content

Commit

Permalink
doc: make param names consistent & fix doc link
Browse files Browse the repository at this point in the history
The parameter to `fs.mkdtemp` is actually `prefix`, not `template`,
because the string passed is appended with the randomly generated
string.

The doc link for `fs.mkdtemp()` was missing and it is included in this
patch.

PR-URL: #6832
Reviewed-By: Claudio Rodriguez <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
thefourtheye authored and rvagg committed Jun 2, 2016
1 parent e1fb480 commit 5afb91b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -923,7 +923,7 @@ fs.mkdtemp(tmpDir + path.sep, (err, folder) => {
});
```

## fs.mkdtempSync(template)
## fs.mkdtempSync(prefix)
<!-- YAML
added: v5.10.0
-->
Expand Down Expand Up @@ -1702,6 +1702,7 @@ Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
[`fs.FSWatcher`]: #fs_class_fs_fswatcher
[`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
[`fs.lstat()`]: #fs_fs_lstat_path_callback
[`fs.mkdtemp()`]: #fs_fs_mkdtemp_prefix_callback
[`fs.open()`]: #fs_fs_open_path_flags_mode_callback
[`fs.read()`]: #fs_fs_read_fd_buffer_offset_length_position_callback
[`fs.readFile`]: #fs_fs_readfile_file_options_callback
Expand Down

0 comments on commit 5afb91b

Please sign in to comment.