mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 15:06:33 +01:00
Code Issues Releases Activity

doc: synchronize argument names for appendFile()

Browse Source 
The documentation used `file` for the first argument to `appendFile()`
functions. However, the code and (more importantly) thrown errors
referred to it as `path`. The latter is especially important because
context is not provided. So you're looking for a function that takes
`path` but that string doesn't appear in your code *or* in the
documentation. It's not until the end user looks at the source code of
Node.js that they can figure out what's going on. This is why it is
important that the names of variables in the documentation match that in
the code. If we want to change this to `file`, then that's OK, but we
need to do it in the source code and error messages too, not just in the
docs. Changing the docs is the smallest change to synchronize everything
so that's what this change does.

PR-URL: https://github.com/nodejs/node/pull/20489
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This commit is contained in:
Rich Trott 2018-05-02 22:20:45 -07:00
parent 6a24c0c4d6
commit a00f76c360
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/api/fs.md
View File

@ -892,7 +892,7 @@ try {
}
```
## fs.appendFile(file, data[, options], callback)
## fs.appendFile(path, data[, options], callback)
<!-- YAML
added: v0.6.7
changes:
@ -912,7 +912,7 @@ changes:
description: The `file` parameter can be a file descriptor now.
-->
* `file` {string|Buffer|URL|number} filename or file descriptor
* `path` {string|Buffer|URL|number} filename or file descriptor
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
@ -939,7 +939,7 @@ If `options` is a string, then it specifies the encoding. Example:
fs.appendFile('message.txt', 'data to append', 'utf8', callback);
```
The `file` may be specified as a numeric file descriptor that has been opened
The `path` may be specified as a numeric file descriptor that has been opened
for appending (using `fs.open()` or `fs.openSync()`). The file descriptor will
not be closed automatically.
@ -955,7 +955,7 @@ fs.open('message.txt', 'a', (err, fd) => {
});
```
## fs.appendFileSync(file, data[, options])
## fs.appendFileSync(path, data[, options])
<!-- YAML
added: v0.6.7
changes:
@ -967,7 +967,7 @@ changes:
description: The `file` parameter can be a file descriptor now.
-->
* `file` {string|Buffer|URL|number} filename or file descriptor
* `path` {string|Buffer|URL|number} filename or file descriptor
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
@ -994,7 +994,7 @@ If `options` is a string, then it specifies the encoding. Example:
fs.appendFileSync('message.txt', 'data to append', 'utf8');
```
The `file` may be specified as a numeric file descriptor that has been opened
The `path` may be specified as a numeric file descriptor that has been opened
for appending (using `fs.open()` or `fs.openSync()`). The file descriptor will
not be closed automatically.
@ -3687,12 +3687,12 @@ condition, since other processes may change the file's state between the two
calls. Instead, user code should open/read/write the file directly and handle
the error raised if the file is not accessible.
### fsPromises.appendFile(file, data[, options])
### fsPromises.appendFile(path, data[, options])
<!-- YAML
added: v10.0.0
-->
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
* `path` {string|Buffer|URL|FileHandle} filename or `FileHandle`
* `data` {string|Buffer}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
@ -3706,7 +3706,7 @@ resolved with no arguments upon success.
If `options` is a string, then it specifies the encoding.
The `file` may be specified as a `FileHandle` that has been opened
The `path` may be specified as a `FileHandle` that has been opened
for appending (using `fsPromises.open()`).
### fsPromises.chmod(path, mode)