-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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 sorting in API references #11331
Conversation
@nodejs/documentation |
@nodejs/documentation It seems, this PR is prone to constantly emerged conflicts due to a big amount of affected docs text. Also, it can cause such conflicts for other PRs. Could it be approved or closed? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but please make sure that its up-to-date before merging.
@jasnell @sam-github Is "This branch has no conflicts with the base branch" a sufficient sign that it's up-to-date? If so, could it be landed with two approvals and 8 days? |
@vsemozhetbyt I think a careful review by you of the diff to make sure your moved text is the same as the text you removed would be a good idea, I don't know if I perfectly trust git conflict algs here, it would be unfortunate to lose docs. And as soon as you do that you can land it, yes, its been 8 days, with two approvals, so its good to go. |
@sam-github I've checked once more, it seems OK to me. However, I have not rights to land it. |
@vsemozhetbyt oh, sorry, I thought that Anyhow, I'll land this. |
Landed in 52b2536 |
PR-URL: #11331 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@sam-github Thank you. Yes, |
PR-URL: nodejs#11331 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Checklist
Affected core subsystem(s)
doc
Some chapters in the API lists were out of alphabetical order due to different adding time or preferring logical order (
open
beforeclose
,unref()
next toref()
and so on). However, docs prefer alphabetical order in the most cases, so such exceptions could be confusing and could prevent a reader from finding a needed chapter.I've abstained from changing an unalphabetical order in two docs:
cli.md
(it seems to be mostly logical) andzlib.md
(due to only one description for async and sync pairs of "Convenience Methods").Relocated chapters (because of mutual relocations some other ones could seem relocated too):
buffer.md
new Buffer(arrayBuffer[, byteOffset [, length]])
(compare the place of:
Class Method: Buffer.from(arrayBuffer[, byteOffset[, length]]))
buf.includes(value[, byteOffset][, encoding])
buf.toJSON()
crypto.md
crypto.timingSafeEqual(a, b)
dns.md
dns.resolvePtr(hostname, callback)
domain.md
many
fs.md
Class: fs.ReadStream
—Event: 'close'
Class: fs.WriteStream
—Event: 'close'
http.md
message.socket
process.md
process.env
tls.md
Class: tls.Server
—Event: 'tlsClientError'
Class: tls.TLSSocket
—tlsSocket.authorized
tls.connect(port[, host][, options][, callback])
tls.connect(path[, options][, callback])
dgram.md
socket.ref()
url.md
many of
urlObject.*
util.md
util.inspect.custom
util._extend(target, source)
v8.md
v8.getHeapSpaceStatistics()
You can easily see these order violations in the tables of content from the relevant .html files.