Skip to content
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.

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

doc: fix some recent nits in fs.md #29906

Closed

Conversation

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Oct 9, 2019

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
  • Fix sorting of sections.
  • Fix sorting of bottom references.
  • Wrap lines at 80 chars.
  • Fix a heading level.
@cjihrig
cjihrig approved these changes Oct 9, 2019
@Fishrock123

This comment has been minimized.

Copy link
Member

Fishrock123 commented Oct 9, 2019

This conflicts with #29890

Copy link
Member

Fishrock123 left a comment

Disagree with the *Sync ordering

@@ -2680,6 +2658,33 @@ The `encoding` option sets the encoding for the `path` while opening the
directory and subsequent read operations (unless otherwise overriden during
reads from the directory).

## fs.openSync(path[, flags, mode])

This comment has been minimized.

Copy link
@Fishrock123

Fishrock123 Oct 9, 2019

Member

This ordering is wrong. The sync versions should directly follow the async versions or else this doc will become horribly confusing.

This comment has been minimized.

Copy link
@vsemozhetbyt

vsemozhetbyt Oct 9, 2019

Author Contributor

If I understand correctly, we never made exceptions in ABC order. See in the current doc:

fs.read(fd, buffer, offset, length, position, callback)
fs.readdir(path[, options], callback)
fs.readdirSync(path[, options])
fs.readFile(path[, options], callback)
fs.readFileSync(path[, options])
fs.readlink(path[, options], callback)
fs.readlinkSync(path[, options])
fs.readSync(fd, buffer, offset, length, position)

Or:

fs.write(fd, buffer[, offset[, length[, position]]], callback)
fs.write(fd, string[, position[, encoding]], callback)
fs.writeFile(file, data[, options], callback)
fs.writeFileSync(file, data[, options])
fs.writeSync(fd, buffer[, offset[, length[, position]]])
fs.writeSync(fd, string[, position[, encoding]])

Should we make an exception now?

This comment has been minimized.

Copy link
@Fishrock123

Fishrock123 Oct 9, 2019

Member

This seems wrong to me, but... ok.

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

vsemozhetbyt commented Oct 9, 2019

@Fishrock123 Should I resolve the conflicts here or do you prefer to merge some parts to #29890 so I can close this PR?

@Fishrock123 Fishrock123 dismissed their stale review Oct 9, 2019

our docs structure is endlessly confusing

Copy link
Member

Fishrock123 left a comment

@vsemozhetbyt Please rebase this onto my branch... and/or wait

(doing in request so no one goes to merge this prematurely..)

@Fishrock123 Fishrock123 mentioned this pull request Oct 9, 2019
3 of 3 tasks complete
@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

vsemozhetbyt commented Oct 9, 2019

I'll wait till #29890 landed. Sorry for being part of endless doc confusing)

@Fishrock123 Fishrock123 dismissed their stale review Oct 10, 2019

Ok #29890 landed, this can be rebased. 😄

@vsemozhetbyt vsemozhetbyt force-pushed the vsemozhetbyt:doc-fs-nits-2019-10-09 branch 2 times, most recently from ea63dc6 to 07fc0b0 Oct 10, 2019
@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

vsemozhetbyt commented Oct 10, 2019

Rebased)

@vsemozhetbyt vsemozhetbyt force-pushed the vsemozhetbyt:doc-fs-nits-2019-10-09 branch from 07fc0b0 to b52e91b Oct 11, 2019
@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

vsemozhetbyt commented Oct 11, 2019

Rebased.

@Trott

This comment has been minimized.

Copy link
Member

Trott commented Oct 12, 2019

Needs another rebase but LGTM otherwise.

@Trott
Trott approved these changes Oct 12, 2019
* Fix sorting of sections.
* Fix sorting of bottom references.
* Wrap lines at 80 chars.
* Fix a heading level.
@vsemozhetbyt vsemozhetbyt force-pushed the vsemozhetbyt:doc-fs-nits-2019-10-09 branch from b52e91b to f296e0c Oct 12, 2019
@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

vsemozhetbyt commented Oct 12, 2019

Rebased.

@Trott

This comment has been minimized.

@Trott Trott added the author ready label Oct 12, 2019
@Trott

This comment has been minimized.

Copy link
Member

Trott commented Oct 12, 2019

Landed in 039eb56

@Trott Trott closed this Oct 12, 2019
Trott added a commit to Trott/io.js that referenced this pull request Oct 12, 2019
* Fix sorting of sections.
* Fix sorting of bottom references.
* Wrap lines at 80 chars.
* Fix a heading level.

PR-URL: nodejs#29906
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@vsemozhetbyt vsemozhetbyt deleted the vsemozhetbyt:doc-fs-nits-2019-10-09 branch Oct 12, 2019
targos added a commit that referenced this pull request Nov 8, 2019
* Fix sorting of sections.
* Fix sorting of bottom references.
* Wrap lines at 80 chars.
* Fix a heading level.

PR-URL: #29906
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos added a commit that referenced this pull request Nov 10, 2019
* Fix sorting of sections.
* Fix sorting of bottom references.
* Wrap lines at 80 chars.
* Fix a heading level.

PR-URL: #29906
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.