Skip to content

doc: documentation of sync methods links now to async methods #21243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
iwko wants to merge 7 commits into from
Closed

doc: documentation of sync methods links now to async methods #21243

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bc0d71c
doc: documentation of sync methods links now to async methods
iwko Jun 10, 2018
651d11a
doc: Link fs.ftruncate and fs.symlink methods
iwko Jun 11, 2018
1dc060a
doc: fs sync methods links now to async methods
iwko Jun 23, 2018
373e6fd
doc: fix max line length in fs.md
iwko Jun 23, 2018
c53f7f4
doc: Remove sentences like 'This is the synchronous version of..' from
iwko Jun 27, 2018
36a392e
doc: change fs.chmod() description
iwko Jun 27, 2018
9921a76
doc: remove unnecessary info about returned value in fs.chmod.
iwko Jul 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: fs sync methods links now to async methods
  • Loading branch information
@iwko @Trott
iwko authored and Trott committed Jul 9, 2018
commit 1dc060af4d9da83051aa6c774cecff0376508989
24 changes: 12 additions & 12 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1140,7 +1140,7 @@ changes:
Synchronously changes the permissions of a file. Returns `undefined`.
This is the synchronous version of [`fs.chmod()`][].
Copy link
Copy Markdown
Member

@joyeecheung joyeecheung Jun 25, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iwko I believe @davisjam and @Trott and I meant that sentence like

 This is the synchronous version of [`fs.chmod()`][].

Should be removed after sentences like

For detailed information, see the documentation of the asynchronous version of
this API: [`fs.chmod()`][].

are added to avoid duplication?

Copy link
Copy Markdown
Contributor Author

@iwko iwko Jun 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am a little confused now. So documentation for fs.chmod() should look like this?

Synchronously changes the permissions of a file. Returns undefined. For detailed information, see the documentation of the asynchronous version of this API: [fs.chmod()][]. See also: chmod(2).
?

Copy link
Copy Markdown
Member

@joyeecheung joyeecheung Jun 25, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iwko Yes, that's my understanding

Copy link
Copy Markdown
Contributor Author

@iwko iwko Jun 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joyeecheung done


For detailed information, see the documentation of [`fs.chmod()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.chmod()`][].

See also: chmod(2).

Expand Down Expand Up @@ -1572,7 +1572,7 @@ changes:
Synchronous version of [`fs.exists()`][].
Returns `true` if the path exists, `false` otherwise.

For detailed information, see the documentation of [`fs.exists()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.exists()`][].

`fs.exists()` is deprecated, but `fs.existsSync()` is not. The `callback`
parameter to `fs.exists()` accepts parameters that are inconsistent with other
Expand Down Expand Up @@ -1827,7 +1827,7 @@ added: v0.8.6

Synchronous ftruncate(2). Returns `undefined`.

For detailed information, see the documentation of [`fs.ftruncate()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.ftruncate()`][].

## fs.futimes(fd, atime, mtime, callback)
<!-- YAML
Expand Down Expand Up @@ -2180,7 +2180,7 @@ added: v5.10.0
The synchronous version of [`fs.mkdtemp()`][]. Returns the created
folder path.

For detailed information, see the documentation of [`fs.mkdtemp()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.mkdtemp()`][].

The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use.
Expand Down Expand Up @@ -2239,7 +2239,7 @@ changes:
Synchronous version of [`fs.open()`][]. Returns an integer representing the file
descriptor.

For detailed information, see the documentation of [`fs.open()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.open()`][].

## fs.read(fd, buffer, offset, length, position, callback)
<!-- YAML
Expand Down Expand Up @@ -2439,7 +2439,7 @@ changes:

Synchronous version of [`fs.readFile()`][]. Returns the contents of the `path`.

For detailed information, see the documentation of [`fs.readFile()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.readFile()`][].

If the `encoding` option is specified then this function returns a
string. Otherwise it returns a buffer.
Expand Down Expand Up @@ -2529,7 +2529,7 @@ changes:

Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.

For detailed information, see the documentation of [`fs.read()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.read()`][].

## fs.realpath(path[, options], callback)
<!-- YAML
Expand Down Expand Up @@ -2646,7 +2646,7 @@ changes:

Synchronous version of [`fs.realpath()`][]. Returns the resolved pathname.

For detailed information, see the documentation of [`fs.realpath()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.realpath()`][].

## fs.realpathSync.native(path[, options])
<!-- YAML
Expand Down Expand Up @@ -2884,7 +2884,7 @@ changes:

Synchronous symlink(2). Returns `undefined`.

For detailed information, see the documentation of [`fs.symlink()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.symlink()`][].

## fs.truncate(path[, len], callback)
<!-- YAML
Expand Down Expand Up @@ -3062,7 +3062,7 @@ changes:

Synchronous version of [`fs.utimes()`][]. Returns `undefined`.

For detailed information, see the documentation of [`fs.utimes()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.utimes()`][].

## fs.watch(filename[, options][, listener])
<!-- YAML
Expand Down Expand Up @@ -3415,7 +3415,7 @@ changes:

The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.

For detailed information, see the documentation of [`fs.writeFile()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.writeFile()`][].

## fs.writeSync(fd, buffer[, offset[, length[, position]]])
<!-- YAML
Expand Down Expand Up @@ -3453,7 +3453,7 @@ changes:

Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.

For detailed information, see the documentation of [`fs.write()`][].
For detailed information, see the documentation of the asynchronous version of this API: [`fs.write()`][].

## fs Promises API

Expand Down