doc: fix sorting in API references#11331
Closed
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 (
openbeforeclose,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.socketprocess.md
process.envtls.md
Class: tls.Server—Event: 'tlsClientError'Class: tls.TLSSocket—tlsSocket.authorizedtls.connect(port[, host][, options][, callback])tls.connect(path[, options][, callback])dgram.md
socket.ref()url.md
many of
urlObject.*util.md
util.inspect.customutil._extend(target, source)v8.md
v8.getHeapSpaceStatistics()You can easily see these order violations in the tables of content from the relevant .html files.